Skip to main content
POST
/
directories
/
admin-portal
Error
A valid request URL is required to generate request examples
{
  "link": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Input for generating a WorkOS Admin Portal link

​
intent
enum<string>
default:dsync

What feature to configure in the Admin Portal

Available options:
sso,
dsync,
audit_logs,
log_streams,
domain_verification
​
return_url
string<uri>

URL to return to after configuration

Response

OK

​
link
string<uri>
required

WorkOS Admin Portal URL for SSO/SCIM configuration

​
expires_at
string<date-time>

When the link expires (typically 5 minutes)