WorkOS · Schema

SlimRole

The primary role assigned to the user.

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
slug string The slug of the assigned role.
View JSON Schema on GitHub

JSON Schema

workos-slimrole-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SlimRole",
  "title": "SlimRole",
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "The slug of the assigned role.",
      "example": "admin"
    }
  },
  "required": [
    "slug"
  ],
  "description": "The primary role assigned to the user."
}