WorkOS · Schema

CreateOrganizationDomainDto

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
domain string The domain to add to the organization.
organization_id string The ID of the organization to add the domain to.
View JSON Schema on GitHub

JSON Schema

workos-createorganizationdomaindto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateOrganizationDomainDto",
  "title": "CreateOrganizationDomainDto",
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The domain to add to the organization.",
      "example": "foo-corp.com"
    },
    "organization_id": {
      "type": "string",
      "description": "The ID of the organization to add the domain to.",
      "example": "org_01EHQMYV6MBK39QC5PZXHY59C3"
    }
  },
  "required": [
    "domain",
    "organization_id"
  ]
}