Sync SSO Users

Sync the full set of SSO users. The organization must have SSO configured. The server computes a delta — new users are provisioned, existing ones are updated, and any user not included is deprovisioned (along with their employee bindings). This operation is synchronous.

Requires scope: user:sync.

Body Params

Request to sync the full set of SSO users. Users not included in this request are deprovisioned along with their employee bindings.

users
array of objects
required

Full set of desired SSO users. The server computes a delta — new users are provisioned, existing ones are updated, and any user not included is deprovisioned.

users*
boolean

When false (default), the server computes and returns the delta without applying any changes — a preview of what the sync would do. Set to true to apply the changes.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json