POST /v1/portal/links
- Scope
portal_links:write- Auth
- Secret key (
sk_…) - Since
- 1.0
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”profilestringorganizationstring Requiredintentsarray of string Requiredreturn_urlstring (uri)success_urlsobjectconnectionstring
Seconds, 60 to 300, for a sealed single-use embed link. Leave it out for a setup link, whose lifetimettlintegerexpires_insets. Not together withexpires_in.min 60 · max 300
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_inintegerexpires_atsays when the link ends. Outside the range, or sent withttl, the request is refused withparameter_invalid(paramexpires_in).min 300 · max 2592000 · default
604800
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.localestring
Responses
Section titled “Responses”- 201 OK PortalLink
- 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
- 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/portal/links" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "intents": [ "sso" ]}'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();import osimport 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(){ "id": "plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "portal_link", "url": "https://app.acme.com/callback", "expires_at": "2026-01-15T09:30:00Z"}