WorkOS · Schema

AuthorizationPermission

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
object	string	Distinguishes the Permission object.
id	string	Unique identifier of the Permission.
slug	string	A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks.
name	string	A descriptive name for the Permission.
description	stringnull	An optional description of the Permission.
system	boolean	Whether the permission is a system permission. System permissions are managed by WorkOS and cannot be deleted.
resource_type_slug	string	The slug of the resource type associated with the permission.
created_at	string	An ISO 8601 timestamp.
updated_at	string	An ISO 8601 timestamp.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuthorizationPermission",
  "title": "AuthorizationPermission",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the Permission object.",
      "const": "permission"
    },
    "id": {
      "type": "string",
      "description": "Unique identifier of the Permission.",
      "example": "perm_01HXYZ123456789ABCDEFGHIJ"
    },
    "slug": {
      "type": "string",
      "description": "A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks.",
      "example": "documents:read"
    },
    "name": {
      "type": "string",
      "description": "A descriptive name for the Permission.",
      "example": "View Documents"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "An optional description of the Permission.",
      "example": "Allows viewing document contents"
    },
    "system": {
      "type": "boolean",
      "description": "Whether the permission is a system permission. System permissions are managed by WorkOS and cannot be deleted.",
      "example": false
    },
    "resource_type_slug": {
      "type": "string",
      "description": "The slug of the resource type associated with the permission.",
      "example": "workspace"
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "required": [
    "object",
    "id",
    "slug",
    "name",
    "description",
    "system",
    "resource_type_slug",
    "created_at",
    "updated_at"
  ]
}