Start an Active Directory sync now for a domain

POST 
/api/v1/DomainSync/scan/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.

Permission required: Admin role. The session must also satisfy the multi-factor authentication requirement.

Caution: The sync starts immediately, and any pending, queued or running sync for this domain is cancelled first.

Request

Responses

200

The sync was scheduled. The body is the job ID.

400

The sync could not be scheduled for this domain.

403

The signed-in user does not have the Admin role or has not satisfied the MFA requirement.

404

The domain is unknown or has no sync queue. The body is the domain name.