LdapSyncResults Data Type

The results of performing an LDAP sync.

Properties
name data type description
status string The final status of the LDAP sync job.

Possible values are:

  • STATUS_COLLECT_RESULTS
  • STATUS_COMPLETED
  • STATUS_STOP_COLLECTING_RESULTS
  • STATUS_ABORTED_BY_ERROR
  • STATUS_SYNC_ALREADY_IN_PROGRESS

added_users array of string The new users that have been found in the LDAP directory.
modified_users array of string The users that have been modified.
deleted_users array of string The users that have been deleted because they could no longer be found in the LDAP directory.
disabled_users array of string The users that have been disabled because they could no longer be found in the LDAP directory.
added_groups array of string The new groups that have been found in the LDAP directory.
modified_groups array of string The groups that have been modified.
deleted_groups array of string The groups that have been deleted because they could no longer be found in the LDAP directory.
error string An message indicating the reason for failure, if an error occurred during LDAP sync.

This message may or may not be localized and is generally not suitable to be displayed to the end user.

Example

{
  "status" : "...",
  "added_users" : [ "...", "..." ],
  "modified_users" : [ "...", "..." ],
  "deleted_users" : [ "...", "..." ],
  "disabled_users" : [ "...", "..." ],
  "added_groups" : [ "...", "..." ],
  "modified_groups" : [ "...", "..." ],
  "deleted_groups" : [ "...", "..." ],
  "error" : "..."
}