Skip to main content
POST
A WorkOS Admin Portal link, for the organization's IT admin to set up SSO or SCIM

Authorizations

X-API-Key
string
header
required

API key

Body

application/json
intent
enum<string>
required

What the admin sets up: single sign-on, directory sync (SCIM), a verified email domain, or audit-log streaming

Available options:
sso,
dsync,
domain_verification,
audit_logs
return_url
string | null

Where the admin goes on leaving the portal

Maximum string length: 2048
Pattern: ^https?://

Response

Successful Response

Open it at once: it expires five minutes after issue and grants the portal's access, so share it with the organization's IT admin only