Knowlege base

User Sync Integration API

Article ID: 504
Last updated: 12 Oct, 2020

Basic Authentication

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:

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:

Authorization: Basic bXl1c2VyOm15cGFzc3dvcmQ=

Start users sync

Starts users synchronization.

Resource URL

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

Resource Information

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

URL Parameters


Request body



202 Accepted

Synchronization has started and will run asynchronously using sync sources manually configured and enabled in Imagicle Application 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


Start users synchronization on host as user admin/admin.

POST /fw/Apps/ApplicationSuite/WebAPI/UsersManagement/Sync/Start HTTP/1.1
Authorization: Basic YWRtaW46YWRtaW4=


curl -X POST \ \
  -H 'authorization: Basic YWRtaW46YWRtaW4='

Article ID: 504
Last updated: 12 Oct, 2020
Revision: 8
Views: 1139
Print Export to PDF Subscribe Share
This article was:  
Prev   Next
Save scheduled reports in a shared Windows folder     Troubleshooting