WorkOS · Schema

UpdateAuthorizationPermissionDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
name string A descriptive name for the Permission.
description stringnull An optional description of the Permission.
View JSON Schema on GitHub

JSON Schema

workos-updateauthorizationpermissiondto-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateAuthorizationPermissionDto",
  "title": "UpdateAuthorizationPermissionDto",
  "type": "object",
  "properties": {
    "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"
    }
  }
}