WorkOS · Schema

UserlandUserOrganizationMembership

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
object string Distinguishes the organization membership object.
id string The unique ID of the organization membership.
user_id string The ID of the user.
organization_id string The ID of the organization which the user belongs to.
status string The status of the organization membership. One of `active`, `inactive`, or `pending`.
directory_managed boolean Whether this organization membership is managed by a directory sync connection.
organization_name string The name of the organization which the user belongs to.
custom_attributes object An object containing IdP-sourced attributes from the linked [Directory User](/reference/directory-sync/directory-user) or [SSO Profile](/reference/sso/profile). Directory User attributes take preceden
created_at string An ISO 8601 timestamp.
updated_at string An ISO 8601 timestamp.
role object The primary role assigned to the user within the organization.
user object The user that belongs to the organization through this membership.
View JSON Schema on GitHub

JSON Schema

workos-userlanduserorganizationmembership-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserlandUserOrganizationMembership",
  "title": "UserlandUserOrganizationMembership",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the organization membership object.",
      "const": "organization_membership"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the organization membership.",
      "example": "om_01HXYZ123456789ABCDEFGHIJ"
    },
    "user_id": {
      "type": "string",
      "description": "The ID of the user.",
      "example": "user_01E4ZCR3C56J083X43JQXF3JK5"
    },
    "organization_id": {
      "type": "string",
      "description": "The ID of the organization which the user belongs to.",
      "example": "org_01EHZNVPK3SFK441A1RGBFSHRT"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "description": "The status of the organization membership. One of `active`, `inactive`, or `pending`.",
      "example": "active"
    },
    "directory_managed": {
      "type": "boolean",
      "description": "Whether this organization membership is managed by a directory sync connection.",
      "example": false
    },
    "organization_name": {
      "type": "string",
      "description": "The name of the organization which the user belongs to.",
      "example": "Acme Corp"
    },
    "custom_attributes": {
      "type": "object",
      "additionalProperties": {},
      "description": "An object containing IdP-sourced attributes from the linked [Directory User](/reference/directory-sync/directory-user) or [SSO Profile](/reference/sso/profile). Directory User attributes take precedence when both are linked.",
      "example": {
        "department": "Engineering",
        "title": "Developer Experience Engineer",
        "location": "Brooklyn"
      }
    },
    "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"
    },
    "role": {
      "$ref": "#/components/schemas/SlimRole",
      "description": "The primary role assigned to the user within the organization."
    },
    "user": {
      "$ref": "#/components/schemas/UserlandUser",
      "description": "The user that belongs to the organization through this membership."
    }
  },
  "required": [
    "object",
    "id",
    "user_id",
    "organization_id",
    "status",
    "directory_managed",
    "created_at",
    "updated_at",
    "role",
    "user"
  ]
}