# Start a test sign-in

<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/connections/&#123;conn&#125;/test</code></p>

The response's attempt_id names this attempt; the test result carries the same ID once it is recorded, so a caller can ignore an earlier attempt's result. scenario picks one of the sandbox test IdP's outcomes and is accepted only in a sandbox environment (sandbox_required elsewhere) on a connection whose IdP is the test IdP (test_idp; parameter_invalid otherwise). time_shift and certificate follow the same rules.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>connections: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">conn</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">scenario</code> <span class="api-field__type">string</span></p>
A sandbox test IdP outcome (sandbox environments and test IdP connections only). `rotated_cert` signs with the test IdP's rotated key (refused with `saml_signature_invalid` until the connection trusts the rotated certificate) and `expiring_cert` with a key whose certificate expires within days, so a certificate rollover and the expiry alerts can be rehearsed; `revoked_user` is the IdP refusing a user whose access it revoked (`saml_idp_status_error`, or `oidc_token_exchange_failed` for OIDC).

<p class="api-field__chips">one of <code>sp_initiated</code>, <code>idp_initiated</code>, <code>guest_domain</code>, <code>bad_signature</code>, <code>expired</code>, <code>wrong_audience</code>, <code>missing_email</code>, <code>rotated_cert</code>, <code>expiring_cert</code>, <code>revoked_user</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">time_shift</code> <span class="api-field__type">string</span></p>
Time travel for the sandbox test IdP (sandbox environments and test IdP connections only), a duration such as `-10m` or `2h`, at most 24h either way. Only the test IdP's clock moves; documents outside the broker's skew allowance are refused as they would be from a real IdP with a wrong clock.

<p class="api-field__chips">max length 16</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">certificate</code> <span class="api-field__type">string</span></p>
The certificate the sandbox test IdP signs with (sandbox environments and test IdP connections only). `rotated` and `expiring` let a certificate rollover be rehearsed with any scenario; with `rotated_cert` or `expiring_cert` it must name that scenario's key (parameter_invalid otherwise).

<p class="api-field__chips">one of <code>current</code>, <code>rotated</code>, <code>expiring</code></p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">ConnectionTest</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/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/test" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "scenario": "sp_initiated",
  "time_shift": "-10m",
  "certificate": "current"
}'
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/test",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      scenario: "sp_initiated",
      time_shift: "-10m",
      certificate: "current",
    }),
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.post(
    "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/test",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "scenario": "sp_initiated",
        "time_shift": "-10m",
        "certificate": "current",
    },
)
data = response.json()
```

```json title="Response 200" wrap
{
  "test_url": "https://app.acme.com/callback",
  "expires_at": "2026-01-15T09:30:00Z",
  "attempt_id": "sgn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "started_at": "2026-01-15T09:30:00Z"
}
```

</div>
</div>
