Domain Sync
Manage domain synchronization.
Cancel the running Active Directory sync for a domain
Marks the sync runs for the domain that are still in progress as cancelled. Use it to stop a sync that is queued or running.
List the errors from one Active Directory sync
Returns the errors recorded during one Active Directory sync run, newest first, each with a time and a message. Use it to find out why a sync reported errors.
Start an Active Directory sync now for a domain
Starts a sync for the named domain immediately. Set fullSync to true to read all objects rather than only changes since the last sync. The response is the ID of the sync job.
Start a sync for a domain configuration
Starts an Active Directory sync now for the domain configuration with the given ID. Set onlyMap to true to run only the resource group mapping instead of the sync.
Set the Active Directory sync schedule for a domain
Saves the sync schedule for the named domain and returns the resulting sync job. Use it to set up recurring syncs.
List Active Directory sync statistics
Returns the statistics for Active Directory sync runs across all domains. Use it to review sync history and results. Entries are newest first. Each has the domain controller, counts of users, groups, members, computers and service accounts processed, start and end times, error and warning counts, and a status, and the job settings used (domain, domain controller and global catalog option).
List sync statistics for one domain
Returns the sync statistics for one Active Directory domain configuration, newest first. Use it to review that domain's sync history. Each entry has the domain controller, counts of users, groups, members, computers and service accounts processed, start and end times, error and warning counts, and a status, and the job settings used (domain, domain controller and global catalog option).
List sync statistics for one domain controller
Returns the sync statistics for runs that used the named domain controller. The name match ignores case. Entries are newest first. Each has the domain controller, counts of users, groups, members, computers and service accounts processed, start and end times, error and warning counts, and a status, and the job settings used (domain, domain controller and global catalog option).
Get one sync statistics entry
Returns the statistics for a single Active Directory sync run, with the domain controller, counts of objects processed, start and end times, error and warning counts, and a status. The job settings are not expanded in this response; it carries only their ID.
Sync the members of one Active Directory group
Runs a synchronization for a single Active Directory group, identified by the distinguished name in the request body, so its membership is refreshed. The call returns when the sync finishes. The group's domain must already be known to the product.