# Create a portal setup link

<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/portal/links</code></p>

<dl class="api-facts"><div><dt>Scope</dt><dd><code>portal_links: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">profile</code> <span class="api-field__type">string</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">organization</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">intents</code> <span class="api-field__type">array of 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">return_url</code> <span class="api-field__type">string (uri)</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">success_urls</code> <span class="api-field__type">object</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">connection</code> <span class="api-field__type">string</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">ttl</code> <span class="api-field__type">integer</span></p>
Seconds, 60 to 300, for a sealed single-use embed link. Leave it out for a setup link, whose lifetime `expires_in` sets. Not together with `expires_in`.

<p class="api-field__chips">min 60 · max 300</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">expires_in</code> <span class="api-field__type">integer</span></p>
Seconds the setup link lasts, 300 (5 minutes) to 2592000 (30 days); default 604800 (7 days), the same whether the link is created through the API or in the dashboard. A link an API key creates opens once; one a member creates in the dashboard can be opened again until it ends. Both are revocable; `expires_at` says when the link ends. Outside the range, or sent with `ttl`, the request is refused with `parameter_invalid` (`param` `expires_in`).

<p class="api-field__chips">min 300 · max 2592000 · default <code>604800</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">locale</code> <span class="api-field__type">string</span></p>
A portal language (BCP 47): en, or one of the machine-translated de, es, fr, ja, pt-BR. Optional on a link or invite; any other value answers parameter_invalid (param locale). The set may grow within v1; clients treat an unknown value as English.
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">201</span> <span>OK <span class="api-field__type">PortalLink</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/portal/links" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "intents": [
    "sso"
  ]
}'
```

**Node**

```javascript wrap
const response = await fetch("https://api.ohauthcat.com/v1/portal/links", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    organization: "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    intents: ["sso"],
  }),
});
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.post(
    "https://api.ohauthcat.com/v1/portal/links",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
        "intents": [
            "sso",
        ],
    },
)
data = response.json()
```

```json title="Response 201" wrap
{
  "id": "plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "object": "portal_link",
  "url": "https://app.acme.com/callback",
  "expires_at": "2026-01-15T09:30:00Z"
}
```

</div>
</div>
