WorkOS · Schema

CreateAuthorizationPermissionDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
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.
resource_type_slug	string	The slug of the resource type this permission is scoped to.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateAuthorizationPermissionDto",
  "title": "CreateAuthorizationPermissionDto",
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "maxLength": 48,
      "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",
      "maxLength": 48,
      "description": "A descriptive name for the Permission.",
      "example": "View Documents"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 150,
      "description": "An optional description of the Permission.",
      "example": "Allows viewing document contents"
    },
    "resource_type_slug": {
      "type": "string",
      "maxLength": 48,
      "description": "The slug of the resource type this permission is scoped to.",
      "example": "document"
    }
  },
  "required": [
    "slug",
    "name"
  ]
}