WorkOS · Schema

DirectoryGroup

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
object	string	Distinguishes the Directory Group object.
id	string	Unique identifier for the Directory Group.
idp_id	string	Unique identifier for the group, assigned by the Directory Provider. Different Directory Providers use different ID formats.
directory_id	string	The identifier of the Directory the Directory Group belongs to.
organization_id	string	The identifier for the Organization in which the Directory resides.
name	string	The name of the Directory Group.
raw_attributes	object	The raw attributes received from the directory provider.
created_at	string	An ISO 8601 timestamp.
updated_at	string	An ISO 8601 timestamp.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DirectoryGroup",
  "title": "DirectoryGroup",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the Directory Group object.",
      "const": "directory_group"
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for the Directory Group.",
      "example": "directory_group_01E1JJS84MFPPQ3G655FHTKX6Z"
    },
    "idp_id": {
      "type": "string",
      "description": "Unique identifier for the group, assigned by the Directory Provider. Different Directory Providers use different ID formats.",
      "example": "02grqrue4294w24"
    },
    "directory_id": {
      "type": "string",
      "description": "The identifier of the Directory the Directory Group belongs to.",
      "example": "directory_01ECAZ4NV9QMV47GW873HDCX74"
    },
    "organization_id": {
      "type": "string",
      "description": "The identifier for the Organization in which the Directory resides.",
      "example": "org_01EZTR6WYX1A0DSE2CYMGXQ24Y"
    },
    "name": {
      "type": "string",
      "description": "The name of the Directory Group.",
      "example": "Developers"
    },
    "raw_attributes": {
      "type": "object",
      "additionalProperties": {},
      "description": "The raw attributes received from the directory provider."
    },
    "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",
    "idp_id",
    "directory_id",
    "organization_id",
    "name",
    "created_at",
    "updated_at"
  ]
}