Skip to content
Dashboard
Theme
Theme

Replay an IdP's SCIM sequence against a directory (sandbox only)

POST /v1/directories/{dir}/scim_replays: Replay an IdP's SCIM sequence against a directory (sandbox only).

View Markdown

POST /v1/directories/{dir}/scim_replays

The test IdP’s SCIM client simulator sends the provisioning sequence of idp (the requests that IdP sends, in its order) to the directory’s SCIM base URL with token, the directory’s SCIM bearer token, and reports each step. Requests leave through the SSRF-safe fetcher (https and public addresses only) and are logged by the SCIM server like any other. The sequence creates, updates and removes test users and groups in the directory. Sandbox environments only (sandbox_required); at most 20 replays per hour per environment (rate_limited with Retry-After).

Scope
directories:write
Auth
Secret key (sk_…)
Since
1.0
  • dir string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • idp string Required

    The test IdP flavor profile whose SCIM sequence is replayed.

    one of generic, okta, entra, google, onelogin, jumpcloud

  • token string Required

    The directory’s current SCIM bearer token (shown once on create and rotate). It is checked against the directory before anything is sent.

    min length 1 · max length 256

  • domain string

    Email domain of the test users (alice@<domain>); a verified domain of the directory’s organization keeps them in domain. Default example.com.

    min length 1 · max length 128

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/scim_replays" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"idp": "generic",
"token": "sk_test_example"
}'
Response 200
{
"object": "scim_replay",
"directory": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"idp": "okta",
"outcome": "passed",
"steps": [
{
"name": "Acme Corp",
"method": "example_method",
"status": 1,
"passed": true
}
],
"total_steps": 1,
"failure": "example_failure",
"created_at": "2026-01-15T09:30:00Z"
}