WorkOS · Schema

Group

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
object string The Group object.
id string The unique ID of the Group.
organization_id string The ID of the Organization the Group belongs to.
name string The name of the Group.
description stringnull An optional description of the Group.
created_at string An ISO 8601 timestamp.
updated_at string An ISO 8601 timestamp.
View JSON Schema on GitHub

JSON Schema

workos-group-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Group",
  "title": "Group",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "The Group object.",
      "example": "group",
      "const": "group"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the Group.",
      "example": "group_01HXYZ123456789ABCDEFGHIJ"
    },
    "organization_id": {
      "type": "string",
      "description": "The ID of the Organization the Group belongs to.",
      "example": "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
    },
    "name": {
      "type": "string",
      "description": "The name of the Group.",
      "example": "Engineering"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "An optional description of the Group.",
      "example": "The engineering team"
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string",
      "description": "An ISO 8601 timestamp.",
      "example": "2026-01-15T12:00:00.000Z"
    }
  },
  "required": [
    "object",
    "id",
    "organization_id",
    "name",
    "description",
    "created_at",
    "updated_at"
  ]
}