Syntax for Synchronizing the Active Directory
POST /api/tenants/{tenantId}/directories/{id}/sync initiates the sync process on the directory identified by its domain name.
Input
Use the supported input parameters to control the command output.
| Parameter | Description |
|---|---|
| URL | https://$vRA/identity/api/tenants/{tenantId}/directories/{id}/sync,
where:
|
| $vRA |
Specifies the appliance name and fully qualified domain name, or IP address of the vRealize Automation server. |
| $token |
Specifies a valid HTTP bearer token with necessary credentials. The bearer token is included in the HEADER of the request. |
Response Status Codes
One of the following codes is displayed as a result of your synchronization request.
| Status Code | Description |
|---|---|
| 200 OK | Your request succeeded and a sync process was initiated. |
| 401 UNAUTHORIZED | The request might not authenticate the user or authentication credentials required. |
| 404 NOT FOUND | The domain name is incorrect or there is no
such domain in the tenant. For example:
Cannot find a directory with domain name 'someDomain' in tenant 'someTenant'! Use the information in the response to troubleshoot the problem with the request. |
curl Command to Synchronize the Active Directory
The following example command
initiates the synchronization process for a directory with domain name
demo.ad-example.local.
curl -X --insecure -H "accept: application/json" -H "Authorization: Bearer $token” https://$vRA/identity/api/tenants/$tenantId/directories/demo.ad-example.local/sync