Sign in
latestOpenAPI 3.1.02026-08-142887561.0 MB

61436a496404

beta.admin.scim

Trigger Scim Sync

Trigger an on-demand SCIM synchronization for the Organization.

Requires SAML authentication to be enabled and the Organization to be in SCIM user provisioning mode. A dry run previews every change without applying it; a real run applies the categories selected in sync_config. Only one run may be active at a time — a conflicting request returns the already-active run.

post/v1/admin/scim/sync

Request body

dry_runboolean

Preview all synchronization changes without applying them.

Example request

{
  "dry_run": true,
  "sync_config": {
    "sync_users": true,
    "sync_groups": true,
    "sync_memberships": true
  }
}

Response

Accepted

run_idstring uuid required

Unique identifier of the created SCIM synchronization run.

Example response

{
  "run_id": "6f9619ff-8b86-d011-b42d-00cf4fc964ff"
}