WorkOS · Schema

CreateOrganizationRoleDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
slug	string	A unique identifier for the role within the organization. When provided, must begin with 'org-' and contain only lowercase letters, numbers, hyphens, and underscores. When omitted, a slug is auto-gene
name	string	A descriptive name for the role.
description	stringnull	An optional description of the role's purpose.
resource_type_slug	string	The slug of the resource type the role is scoped to.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateOrganizationRoleDto",
  "title": "CreateOrganizationRoleDto",
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "maxLength": 48,
      "description": "A unique identifier for the role within the organization. When provided, must begin with 'org-' and contain only lowercase letters, numbers, hyphens, and underscores. When omitted, a slug is auto-generated from the role name and a random suffix.",
      "example": "org-billing-admin"
    },
    "name": {
      "type": "string",
      "maxLength": 48,
      "description": "A descriptive name for the role.",
      "example": "Billing Administrator"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 150,
      "description": "An optional description of the role's purpose.",
      "example": "Can manage billing and invoices"
    },
    "resource_type_slug": {
      "type": "string",
      "maxLength": 48,
      "description": "The slug of the resource type the role is scoped to.",
      "example": "organization"
    }
  },
  "required": [
    "name"
  ]
}