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​

Body

required

    directoryId stringrequired

    The directory id for this synchronization. This value is required

    id stringrequired

    The id of the user to be synchronized. The type of the id is specified by idType.

    idType string

    Possible values: [UUID, USERID, EXTERNALID]

    The type of the id identifying the user. The value can be one of UUID (the user's internal UUID) or USERID (the user's userId). The value of EXTERNALID is currently not supported. If not specified, this defaults to USERID.

Responses​

Successful

Schema

    directoryId string

    The directory Id for this user.

    directoryUuid string

    The directory uuid for this user.

    searchBaseId string

    The searchBase Id for this user.

    status stringrequired

    Possible values: [CONVERTED, CREATED, DELETED, LOCALIZED_ENABLED, LOCALIZED_DISABLED, UPDATED]

    The outcome of the synchronization.

    userId stringrequired

    The user Id for this user.

    uuid stringrequired

    The uuid for this user.

Loading...