# Session cutover helper during an active import

<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/sessions/migrate</code></p>

The app's server-side SDK reads the user from the old provider (its userinfo endpoint; the token never reaches us) and sends the legacy profile ID. It resolves only through the import's legacy IDs (`profiles.legacy_ids` under the import's source) in organizations the import imported and has not rolled back, while the import is running or completed; each legacy ID resolves once (`import_state_conflict` afterwards). The email must still be in a verified domain of the organization. Audited (`session.migrated`).

<dl class="api-facts"><div><dt>Scope</dt><dd><code>imports: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>

## 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">import</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">legacy_profile_id</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min length 1</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">SessionMigrateResult</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">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/sessions/migrate" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "import": "imp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "legacy_profile_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5"
}'
```

**Node**

```javascript wrap
const response = await fetch("https://api.ohauthcat.com/v1/sessions/migrate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    import: "imp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    legacy_profile_id: "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  }),
});
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.post(
    "https://api.ohauthcat.com/v1/sessions/migrate",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "import": "imp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
        "legacy_profile_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    },
)
data = response.json()
```

```json title="Response 200" wrap
{
  "profile": {
    "claims": {},
    "risk": {
      "score": 0,
      "reasons": ["impossible_travel"],
      "degraded": true
    },
    "custom_attributes": {},
    "policy_hints": {
      "force_sso": true,
      "force_sso_excluded": true,
      "max_age_seconds": 1,
      "idp_initiated_allowed": true,
      "guest": true
    },
    "access_policy": "guest",
    "email_verified": true,
    "idp_groups_verified": true,
    "id": "prof_01J9ZQ4M7K2X8V3N5B6C1D0E9F",
    "object": "profile",
    "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    "connection_id": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    "connection_type": "saml",
    "idp_id": "0oa1b2c3d4E5F6g7h8i9",
    "email": "jane@acme.com",
    "email_domain_verified": true,
    "first_name": "Jane",
    "last_name": "Doe",
    "groups": ["Engineering"],
    "role": "admin",
    "attributes": {},
    "raw_attributes": {},
    "legacy_ids": {
      "workos": "org_01H8ZQ4M7K2X8V3N5B6C1D0E9F"
    }
  }
}
```

</div>
</div>
