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

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-post">POST</span> <code>/v1/directories/&#123;dir&#125;/scim_replays</code></p>

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`).

<dl class="api-facts"><div><dt>Scope</dt><dd><code>directories:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Path parameters

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">dir</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
</li>
</ul>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">Idempotency-Key</code> <span class="api-field__type">string</span></p>
Honoured for 24 h; a replay returns the original response.

<p class="api-field__chips">min length 1 · max length 255</p>
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">idp</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
The test IdP flavor profile whose SCIM sequence is replayed.

<p class="api-field__chips">one of <code>generic</code>, <code>okta</code>, <code>entra</code>, <code>google</code>, <code>onelogin</code>, <code>jumpcloud</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">token</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
The directory's current SCIM bearer token (shown once on create and rotate). It is checked against the directory before anything is sent.

<p class="api-field__chips">min length 1 · max length 256</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">domain</code> <span class="api-field__type">string</span></p>
Email domain of the test users (`alice@<domain>`); a verified domain of the directory's organization keeps them in domain. Default `example.com`.

<p class="api-field__chips">min length 1 · max length 128</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>The replay ran; `outcome` says whether every step got the response the IdP expects. <span class="api-field__type">ScimReplay</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">404</span> <span>Code: <a href="/errors/resource_not_found/">resource_not_found</a> (also returned for other tenants' IDs); a path no endpoint serves answers <a href="/errors/route_not_found/">route_not_found</a>. 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. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">409</span> <span>Codes: <a href="/errors/idempotency_key_reused/">idempotency_key_reused</a> and resource-specific conflicts. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
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"
}'
```

**Node**

```javascript wrap
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();
```

**Python**

```python wrap
import os
import 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()
```

```json title="Response 200" wrap
{
  "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"
}
```

</div>
</div>
