Invite an IT admin to the portal
POST /v1/portal/invites: Invite an IT admin to the portal.
POST /v1/portal/invites
- 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 Requiredemailstring (email)
Seconds; default and maximum 604800 (7 days).ttlintegermin 300 · max 604800
Default true. When false, the invite can be opened again until it expires or is revoked.single_useboolean
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 PortalInvite
- 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/invites" \ -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/invites", { 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/invites", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "intents": [ "sso", ], },)data = response.json(){ "completion": { "features": [ "sso" ], "connection": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "directory": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "portal_setup_completion", "completed_at": "2026-01-15T09:30:00Z" }, "profile": "pprof_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "id": "pinv_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "portal_invite", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "intents": [ "sso" ], "email": "jane@acme.com", "state": "pending", "url": "https://app.acme.com/callback", "expires_at": "2026-01-15T09:30:00Z", "created_at": "2026-01-15T09:30:00Z"}