WorkOS · Schema

WidgetSessionTokenDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
organization_id string The ID of the organization to scope the widget session to.
user_id string The ID of the user to issue the widget session token for.
scopes array The scopes to grant the widget session.
View JSON Schema on GitHub

JSON Schema

workos-widgetsessiontokendto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WidgetSessionTokenDto",
  "title": "WidgetSessionTokenDto",
  "type": "object",
  "properties": {
    "organization_id": {
      "type": "string",
      "description": "The ID of the organization to scope the widget session to.",
      "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
    },
    "user_id": {
      "type": "string",
      "description": "The ID of the user to issue the widget session token for.",
      "example": "user_01E4ZCR3C56J083X43JQXF3JK5"
    },
    "scopes": {
      "type": "array",
      "description": "The scopes to grant the widget session.",
      "items": {
        "type": "string",
        "enum": [
          "widgets:users-table:manage",
          "widgets:domain-verification:manage",
          "widgets:sso:manage",
          "widgets:api-keys:manage",
          "widgets:dsync:manage",
          "widgets:audit-log-streaming:manage"
        ]
      },
      "example": [
        "widgets:users-table:manage"
      ]
    }
  },
  "required": [
    "organization_id"
  ]
}