GetDirectorySyncStatusResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetDirectorySyncStatusResponse",
  "title": "GetDirectorySyncStatusResponse",
  "type": "object",
  "properties": {
    "enableDirSync": {
      "type": "boolean",
      "example": true,
      "description": "The toggle to enable/disable directory sync."
    },
    "directorySyncStatus": {
      "type": "object",
      "properties": {
        "lastSyncStartTime": {
          "type": "string",
          "example": "2021-04-01T14:49:50.309640Z",
          "description": "The start date and time of the last sync."
        },
        "lastSyncEndTime": {
          "type": "string",
          "example": "2021-04-01T14:49:52.667189Z",
          "description": "The end date and time of the last sync."
        },
        "syncStatus": {
          "type": "string",
          "example": "COMPLETE",
          "description": "The sync status of the enterprise."
        },
        "usersAdded": {
          "type": "number",
          "example": 44,
          "description": "The number of users added to Common Identity (CI) in this sync."
        },
        "usersUpdated": {
          "type": "number",
          "example": 21,
          "description": "The number of users updated in Common Identity (CI) in this sync."
        },
        "usersDeleted": {
          "type": "number",
          "example": 34,
          "description": "The number of users deleted from Common Identity (CI) in this sync."
        },
        "machinesAdded": {
          "type": "number",
          "example": 24,
          "description": "The number of machines added to Common Identity (CI) in this sync."
        },
        "machinesUpdated": {
          "type": "number",
          "example": 4,
          "description": "The number of machines updated in Common Identity (CI) in this sync."
        },
        "machinesDeleted": {
          "type": "number",
          "example": 9,
          "description": "The number of machines deleted from Common Identity (CI) in this sync."
        },
        "totalExternalUsersInCI": {
          "type": "number",
          "example": 1077,
          "description": "The number of total external users that have been added to CI across all syncs."
        },
        "totalExternalMachinesInCI": {
          "type": "number",
          "example": 326,
          "description": "The number of total external machines that have been added to Common Identity (CI) across all syncs."
        },
        "lastSuccessfulSyncTime": {
          "type": "string",
          "example": "2021-04-01T14:48:30.502539Z",
          "description": "The date and time of the last successful sync."
        },
        "lastSyncTrackingId": {
          "type": "string",
          "example": "NA_dde3a13a-bad7-4990-b155-9b4574e545b9",
          "description": "Unique tracking identifier."
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "errorCode": {
                "type": "number",
                "example": 6003,
                "description": "An error code that identifies the reason for the error"
              },
              "description": {
                "type": "string",
                "example": "Broadworks External Directory User Sync failed while trying to connect to Broadworks cluster.",
                "description": "A textual representation of the error code."
              }
            }
          },
          "description": "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."
        },
        "userContactsAdded": {
          "type": "number",
          "example": 5,
          "description": "The number of user contacts added to Contact service in this sync."
        },
        "userContactsUpdated": {
          "type": "number",
          "example": 2,
          "description": "The number of user contacts updated in Contact service in this sync."
        },
        "userContactsDeleted": {
          "type": "number",
          "example": 1,
          "description": "The number of user contacts deleted from Contact service in this sync."
        },
        "orgContactsAdded": {
          "type": "number",
          "example": 5,
          "description": "The number of org contacts added to Contact service in this sync."
        },
        "orgContactsUpdated": {
          "type": "number",
          "example": 2,
          "description": "The number of org contacts updated in Contact service in this sync."
        },
        "orgContactsDeleted": {
          "type": "number",
          "example": 1,
          "description": "The number of org contacts deleted from Contact service in this sync."
        },
        "totalUserContactsInContactService": {
          "type": "number",
          "example": 10,
          "description": "The total number of user contacts in Contact service."
        },
        "totalOrgContactsInContactService": {
          "type": "number",
          "example": 2,
          "description": "The total number of org contacts in Contact service."
        }
      },
      "description": "Directory sync status"
    }
  }
}