WorkOS · Schema

CreateGroupDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
name	string	The name of the Group.
description	stringnull	An optional description of the Group.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateGroupDto",
  "title": "CreateGroupDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256,
      "description": "The name of the Group.",
      "example": "Engineering"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 150,
      "description": "An optional description of the Group.",
      "example": "The engineering team"
    }
  },
  "required": [
    "name"
  ]
}