Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex. Please visit Webex for Developers to manage your apps.

Get Directory Sync Status for an Enterprise

This API will allow a Partner Admin to get the most recent directory sync status for a customer Broadworks enterprise on Cisco Webex.

GET/v1/broadworks/enterprises/{id}/broadworksDirectorySync
URI Parameters
id
stringrequired

A unique identifier for the enterprise in question.

Response Properties
enableDirSync
boolean

The toggle to enable/disable directory sync.

directorySyncStatus
object

Directory sync status

lastSyncStartTime
string

The start date and time of the last sync.

lastSyncEndTime
string

The end date and time of the last sync.

syncStatus
string

The sync status of the enterprise.

usersAdded
number

The number of users added to CI in this sync.

usersUpdated
number

The number of users updated in CI in this sync.

usersDeleted
number

The number of users deleted from CI in this sync.

machinesAdded
number

The number of machines added to CI in this sync.

machinesUpdated
number

The number of machines updated in CI in this sync.

machinesDeleted
number

The number of machines deleted from CI in this sync.

totalExternalUsersInCI
number

The number of total external users that have been added to CI across all syncs.

totalExternalMachinesInCI
number

The number of total external machines that have been added to CI across all syncs.

lastSuccessfulSyncTime
string

The date and time of the last successful sync.

lastSyncTrackingId
string

Unique tracking identifier.

errors
array

List of errors that occurred during that last attempt to sync this BroadWorks enterprise. This list captures errors that occurred during directory sync of the BroadWorks enterprise, after the API has been accepted and 200 OK response returned. Any errors that occur during initial API request validation will be captured directly in error response with appropriate HTTP status code.

errorCode

An error code that identifies the reason for the error

Possible values: 6003
description

A textual representation of the error code.

Possible values: Broadworks External Directory User Sync failed while trying to connect to Broadworks cluster.
Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/broadworks/enterprises//broadworksDirectorySync
Log in to try the API.
Header
https://webexapis.com/v1/broadworks/enterprises/Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk/broadworksDirectorySync
200 / OK
{
    "enableDirSync" : true,
    "directorySyncStatus" : {
        "lastSyncStartTime" : "2021-03-23T16:09:06.527199Z",
        "lastSyncEndTime" : "2021-03-23T17:21:41.532770Z",
        "syncStatus" : "COMPLETE",
        "usersAdded" : 44,
        "usersUpdated" : 21,
        "usersDeleted" : 34,
        "machinesAdded" : 24,
        "machinesUpdated" : 4,
        "machinesDeleted" : 9,
        "totalExternalUsersInCI" : 1077,
        "totalExternalMachinesInCI" : 326,
        "lastSyncTrackingId" : "NA_dde3a13a-bad7-4990-b155-9b4574e545b9"
    }
}