Users' Sync Trigger

The REST API identifies its user with HTTP Basic Authentication. That is, if a function requires authentication, then it requires the Authorization HTTP header, which must be as follows:

CODE

Authorization: Basic <userPasswordBase64>

where <userPasswordBase64> is the base64 encoding of <user>:<password>.

For instance, suppose you need to call a function with user="myuser" and password="mypassword". You need to base64-encode the string "myuser:mypassword", which is "bXl1c2VyOm15cGFzc3dvcmQ=", obtaining the following HTTP header:

CODE

Authorization: Basic bXl1c2VyOm15cGFzc3dvcmQ=

Start users sync

Resource URL

POST fw/Apps/ApplicationSuite/WebAPI/UsersManagement/Sync/Start

Resource Information

Request Content-Type: -
Response Content-Type: -
Requires authentication: Yes

URL Parameters

None

Request body

None

Response

202 Accepted

Synchronization has started and will run asynchronously using sync sources manually configured and enabled in Imagicle UCX Suite Web interface.

Error response

401 Unauthorized

No authentication provided
Wrong credentials

403 Forbidden

Insufficient privilege level

409 Conflict

Users synchronization is disabled

503 Service Unavailable

User synchronization is already in progress

504 Gateway Timeout

Synchronization service is down

Examples

Start users synchronization on host ias.contoso.com as user admin/admin.
HTTP:

CODE

POST /fw/Apps/ApplicationSuite/WebAPI/UsersManagement/Sync/Start HTTP/1.1
Host: ias.contoso.com
Authorization: Basic YWRtaW46YWRtaW4=

cURL:

CODE

curl -X POST \
  http://ias.contoso.com/fw/Apps/ApplicationSuite/WebAPI/UsersManagement/Sync/Start \
  -H 'authorization: Basic YWRtaW46YWRtaW4='