WorkOS · Schema

OrganizationDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name	Type	Description
name	string	The name of the organization.
allow_profiles_outside_organization	boolean	Whether the organization allows profiles from outside the organization to sign in.
domains	array	The domains associated with the organization. Deprecated in favor of `domain_data`.
domain_data	array	The domains associated with the organization, including verification state.
metadata	objectnull	Object containing [metadata](/authkit/metadata) key/value pairs associated with the Organization.
external_id	stringnull	An external identifier for the Organization.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OrganizationDto",
  "title": "OrganizationDto",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the organization.",
      "example": "Foo Corp"
    },
    "allow_profiles_outside_organization": {
      "type": "boolean",
      "description": "Whether the organization allows profiles from outside the organization to sign in.",
      "example": false
    },
    "domains": {
      "description": "The domains associated with the organization. Deprecated in favor of `domain_data`.",
      "example": [
        "example.com"
      ],
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "domain_data": {
      "description": "The domains associated with the organization, including verification state.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrganizationDomainDataDto"
      }
    },
    "metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string",
        "maxLength": 600
      },
      "maxProperties": 50,
      "example": {
        "tier": "diamond"
      },
      "description": "Object containing [metadata](/authkit/metadata) key/value pairs associated with the Organization.",
      "propertyNames": {
        "maxLength": 40
      }
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 128,
      "pattern": "^[\\x00-\\x7F]+$",
      "example": "ext_12345",
      "description": "An external identifier for the Organization."
    }
  },
  "required": [
    "name"
  ]
}