Sign in
latestOpenAPI 3.1.02026-08-142887561.0 MB

61436a496404

beta.admin.scim

Get Scim Sync Run

Retrieve an on-demand SCIM synchronization run for the Organization.

Returns the run's lifecycle status along with the preview or result summary once the synchronization plan has been built.

get/v1/admin/scim/sync/{run_id}

Path parameters

run_idstring uuid required

Identifier of the SCIM synchronization run.

Example:6f9619ff-8b86-d011-b42d-00cf4fc964ff

Identifier of the SCIM synchronization run.

Response

OK

run_idstring uuid required

Unique identifier of the SCIM synchronization run.

status'PENDING' | 'RUNNING' | 'SUCCESS' | 'SKIPPED' | 'FAILED' required
dry_runboolean required

Whether the run only previewed changes.

created_atstring date-time required

Time at which the synchronization run was created.

started_atstring date-time nullable required

Time at which processing started, if it has started.

finished_atstring date-time nullable required

Time at which processing finished, if it has finished.

error_messagestring nullable required

Failure detail when the synchronization run could not complete.

Example response

{
  "run_id": "6f9619ff-8b86-d011-b42d-00cf4fc964ff",
  "dry_run": true,
  "sync_config": {
    "sync_users": true,
    "sync_groups": true,
    "sync_memberships": true
  },
  "created_at": "2026-07-28T10:00:00Z",
  "started_at": "2026-07-28T10:00:01Z",
  "finished_at": "2026-07-28T10:00:05Z",
  "error_message": "Failed to fetch users from the SCIM provider."
}