WorkOS · Schema

SetRolePermissionsDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
permissions array The permission slugs to assign to the role.
View JSON Schema on GitHub

JSON Schema

workos-setrolepermissionsdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SetRolePermissionsDto",
  "title": "SetRolePermissionsDto",
  "type": "object",
  "properties": {
    "permissions": {
      "description": "The permission slugs to assign to the role.",
      "example": [
        "billing:read",
        "billing:write",
        "invoices:manage",
        "reports:view"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "permissions"
  ]
}