Skip to content
Dashboard
Theme
Theme

Invite an IT admin to the portal

POST /v1/portal/invites: Invite an IT admin to the portal.

View Markdown

POST /v1/portal/invites

Scope
portal_links:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • profile string

  • organization string Required

  • intents array of string Required

  • email string (email)

  • ttl integer

    Seconds; default and maximum 604800 (7 days).

    min 300 · max 604800

  • single_use boolean

    Default true. When false, the invite can be opened again until it expires or is revoked.

  • locale string

    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.

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"
]
}'
Response 201
{
"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"
}