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).
POST /
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
Path parameters
Section titled “Path parameters”dirstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”
The test IdP flavor profile whose SCIM sequence is replayed.idpstring Requiredone of
generic,okta,entra,google,onelogin,jumpcloud
The directory’s current SCIM bearer token (shown once on create and rotate). It is checked against the directory before anything is sent.tokenstring Requiredmin length 1 · max length 256
Email domain of the test users (domainstringalice@<domain>); a verified domain of the directory’s organization keeps them in domain. Defaultexample.com.min length 1 · max length 128
Responses
Section titled “Responses”- 200 The replay ran;
outcomesays whether every step got the response the IdP expects. ScimReplay - 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"}'const response = await fetch("https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/scim_replays", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "idp": "generic", "token": "sk_test_example" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/scim_replays", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "idp": "generic", "token": "sk_test_example", },)data = response.json(){ "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"}