Get directory synchronization status

GET 
/api/web/v1/directorysyncinfo/:id

Get the specified directory synchronization status details. Caller requires the DIRECTORIES:VIEW permission.

Request

Path Parameters

id stringrequired

The UUID of the directory whose synchronization status is to be returned.

Responses

200

Successful

application/json

Schema

Schema

directoryName string

The name of the directory.

directoryOrSearchBaseBeingProcessed string

The name of the directory or searchbase is being processed.

errors string

Comma separated list of errors occurred during the AD-sync process.

groupsAdded int32

The number of groups added.

groupsCreateCount int32

The number of groups successfully created in the service database.

groupsDeleteCount int32

The number of groups successfully deleted from the service database.

groupsFailCount int32

The number of groups failed to be uploaded.

groupsFailed int32

The number of groups skipped due to errors.

groupsProcessedSuccessfully int32deprecated

The number of groups processed successfully.

groupsRemoved int32

The number of groups removed.

groupsSyncedWithChanges int32

The number of groups changed.

groupsSyncedWithNoChanges int32

The number of groups synced with no changes.

groupsUpdateCount int32

The number of groups successfully updated in the service database.

id string

The UUID of the DirectorySyncStatusInfo.

searchbasesProcessed int32

The number of search bases already processed.

state string

Possible values: [CRAWLING, CRAWL_COMPLETE, ERROR, NOTIFYING_GROUPS, NOTIFYING_GROUPS_USERS, NOTIFYING_USERS, NOTIFY_COMPLETE, OUT_OF_SYNC, PENDING_CHANGES, SYNCED, UNKNOWN]

The status of the Directory Sync processed.

syncStarted date-time

The time when the synchronization was started.

syncUpdated date-time

The last time the directory was updated.

totalSearchbases int32

Total number of search bases to be processed.

usersAdded int32

Number of users added.

usersCreateCount int32

The number of users successfully created in the service database.

usersDeleteCount int32

The number of users successfully deleted from the service database.

usersFailCount int32

The number of users failed to be uploaded.

usersFailed int32

The number of users skipped due to errors.

usersProcessedSuccessfully int32deprecated

The number of users processed successfully.

usersRemoved int32

The number of users removed.

usersSyncedWithChanges int32

The number of users synced with changes.

usersSyncedWithNoChanges int32

The number of users synced with no changes.

usersUpdateCount int32

The number of users successfully updated in the service database.

Example (from schema)

{
  "directoryName": "string",
  "directoryOrSearchBaseBeingProcessed": "string",
  "errors": "string",
  "groupsAdded": 0,
  "groupsCreateCount": 0,
  "groupsDeleteCount": 0,
  "groupsFailCount": 0,
  "groupsFailed": 0,
  "groupsRemoved": 0,
  "groupsSyncedWithChanges": 0,
  "groupsSyncedWithNoChanges": 0,
  "groupsUpdateCount": 0,
  "id": "string",
  "searchbasesProcessed": 0,
  "state": "CRAWLING",
  "syncStarted": "2019-02-19T13:15:27Z",
  "syncUpdated": "2019-02-19T13:15:27Z",
  "totalSearchbases": 0,
  "usersAdded": 0,
  "usersCreateCount": 0,
  "usersDeleteCount": 0,
  "usersFailCount": 0,
  "usersFailed": 0,
  "usersRemoved": 0,
  "usersSyncedWithChanges": 0,
  "usersSyncedWithNoChanges": 0,
  "usersUpdateCount": 0
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...