WorkOS · Schema

PortalLinkResponse

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
link string An ephemeral link to initiate the Admin Portal.
View JSON Schema on GitHub

JSON Schema

workos-portallinkresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PortalLinkResponse",
  "title": "PortalLinkResponse",
  "type": "object",
  "properties": {
    "link": {
      "type": "string",
      "description": "An ephemeral link to initiate the Admin Portal.",
      "example": "https://setup.workos.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
  },
  "required": [
    "link"
  ]
}