Skip to main content

Synchronize a new user or an existing user

POST 
/api/web/v1/syncusers/sync

Synchronize a user. Caller requires the USERS:EDIT permission. An Identity as a Service directory must be configured and associated with an Identity as a Service Gateway 5.0 or later. If you unsynchronize a user using the unsync API, the user becomes locally managed. In order to set the user back to an AD Sync user, the user should be synchronized again using this API. Using an AD Sync crawl will only re-synchronize the user if the user is updated in AD (i.e., the user's last update time in AD is updated) or a new custom user attribute mapping is added for the directory (this resets The last update time for all users such that all AD users will be re-synchronlized).

The following response status attribute values are possible:

  • CONVERTED: the locally managed Identity as a Service user was converted into an AD Sync user.
  • CREATED: a new user was created as an AD Sync user.
  • DELETED: the user was not found in AD and has been deleted in Identity as a Service.
  • LOCALIZED_ENABLED: the user was not found in AD and has been set as locally managed and enabled in Identity as a Service.
  • LOCALIZED_DISABLED: the user was not found in AD and has been set as locally managed and disabled in Identity as a Service.
  • UPDATED: the user was synchronized.

Request​

Responses​

Successful