Skip to main content
POST
/
directories
/
admin-portal
Get Admin Portal link
curl --request POST \
  --url https://app.usechar.ai/api/directories/admin-portal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "dsync",
  "return_url": "<string>"
}
'
{
  "link": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.

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)