--- title: "Add an email domain" description: "The domain starts pending, with the TXT record to publish. sso-worker looks for the record at once, then every 15 minutes for a week, and rechecks a verified domain every 6 hours. A domain is verified in only one directory at a time." --- > Documentation Index > Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt > Use this file to discover all available pages before exploring further. Path: EZGH SSO API `POST /v1/organizations/{orgId}/sso/domains` The domain starts pending, with the TXT record to publish. sso-worker looks for the record at once, then every 15 minutes for a week, and rechecks a verified domain every 6 hours. A domain is verified in only one directory at a time. ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `CreateDomain.path.orgId` (string, required) - format `uuid` ## Header parameters - `CreateDomain.header.Idempotency-Key` (string, optional) — Makes a retry safe: the same key and request get the stored response. - pattern `^[\x21-\x7e]{1,200}$` ## Request body _Required._ - `CreateDomain.domain` (string, required) - maxLength 253 ## Example request ```json { "domain": "string" } ``` ## Code samples ### cURL ```curl curl --request POST \ --url https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/domains \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "domain": "string" } ' ``` ### TypeScript ```typescript const url = 'https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/domains'; const options = { method: 'POST', headers: {'Content-Type': 'application/json', Authorization: 'Bearer '}, body: JSON.stringify({domain: 'string'}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/domains" payload = { "domain": "string" } headers = { "Content-Type": "application/json", "Authorization": "Bearer " } response = requests.post(url, json=payload, headers=headers) print(response.text) ``` ## Responses ### 201 The domain and its verification record. #### Example ```json { "checkError": "string", "checkRequestedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18", "domain": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "identityProviderId": "cabc3c19-9da4-42ad-97d5-81996b056f78", "lastCheckedAt": "2019-08-24T14:15:22Z", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "status": "pending", "updatedAt": "2019-08-24T14:15:22Z", "verification": { "recordName": "string", "recordType": "TXT", "recordValue": "string" }, "verifiedAt": "2019-08-24T14:15:22Z" } ``` - `CreateDomain.response.201.checkError` (string | null, required) - `CreateDomain.response.201.checkRequestedAt` (string | null, required) - format `date-time` - `CreateDomain.response.201.createdAt` (string, required) - format `date-time` - `CreateDomain.response.201.directoryId` (string, required) - format `uuid` - `CreateDomain.response.201.domain` (string, required) — Lowercase ASCII; an internationalized domain in its xn-- form. - `CreateDomain.response.201.id` (string, required) - format `uuid` - `CreateDomain.response.201.identityProviderId` (string | null, required) — The identity provider the domain routes to; null signs its people in hosted. - format `uuid` - `CreateDomain.response.201.lastCheckedAt` (string | null, required) - format `date-time` - `CreateDomain.response.201.organizationId` (string, required) - format `uuid` - `CreateDomain.response.201.status` (string, required) — pending until sso-worker finds the TXT record; verified while it stays published (two consecutive misses make it pending again). Routing and JIT apply only to verified domains. - one of `"pending"`, `"verified"` - `CreateDomain.response.201.updatedAt` (string, required) - format `date-time` - `CreateDomain.response.201.verification` (object, required) - `CreateDomain.response.201.verification.recordName` (string, required) — _ezgh-sso-verification. - `CreateDomain.response.201.verification.recordType` (string, required) - one of `"TXT"` - `CreateDomain.response.201.verification.recordValue` (string, required) — ezgh-sso-verification= - `CreateDomain.response.201.verifiedAt` (string | null, required) - format `date-time` ### 400 invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.400.error` (object, required) - `CreateDomain.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.400.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.400.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.400.error.issues.message` (string, required) - `CreateDomain.response.400.error.issues.path` (string, required) - `CreateDomain.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.400.error.quota.id` (string, required) - `CreateDomain.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.400.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.400.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.400.error.quota.region` (string, optional) - `CreateDomain.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.400.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.400.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 401 unauthenticated: no credential, or one that doesn't check out. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.401.error` (object, required) - `CreateDomain.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.401.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.401.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.401.error.issues.message` (string, required) - `CreateDomain.response.401.error.issues.path` (string, required) - `CreateDomain.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.401.error.quota.id` (string, required) - `CreateDomain.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.401.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.401.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.401.error.quota.region` (string, optional) - `CreateDomain.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.401.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.401.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 403 access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.403.error` (object, required) - `CreateDomain.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.403.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.403.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.403.error.issues.message` (string, required) - `CreateDomain.response.403.error.issues.path` (string, required) - `CreateDomain.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.403.error.quota.id` (string, required) - `CreateDomain.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.403.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.403.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.403.error.quota.region` (string, optional) - `CreateDomain.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.403.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.403.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 404 not_found: unknown, malformed, or in an organization the caller isn't in. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.404.error` (object, required) - `CreateDomain.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.404.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.404.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.404.error.issues.message` (string, required) - `CreateDomain.response.404.error.issues.path` (string, required) - `CreateDomain.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.404.error.quota.id` (string, required) - `CreateDomain.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.404.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.404.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.404.error.quota.region` (string, optional) - `CreateDomain.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.404.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.404.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 409 quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.409.error` (object, required) - `CreateDomain.response.409.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.409.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.409.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.409.error.issues.message` (string, required) - `CreateDomain.response.409.error.issues.path` (string, required) - `CreateDomain.response.409.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.409.error.quota.id` (string, required) - `CreateDomain.response.409.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.409.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.409.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.409.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.409.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.409.error.quota.region` (string, optional) - `CreateDomain.response.409.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.409.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.409.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.409.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 413 payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise). #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.413.error` (object, required) - `CreateDomain.response.413.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.413.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.413.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.413.error.issues.message` (string, required) - `CreateDomain.response.413.error.issues.path` (string, required) - `CreateDomain.response.413.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.413.error.quota.id` (string, required) - `CreateDomain.response.413.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.413.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.413.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.413.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.413.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.413.error.quota.region` (string, optional) - `CreateDomain.response.413.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.413.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.413.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.413.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 429 too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.429.error` (object, required) - `CreateDomain.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.429.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.429.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.429.error.issues.message` (string, required) - `CreateDomain.response.429.error.issues.path` (string, required) - `CreateDomain.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.429.error.quota.id` (string, required) - `CreateDomain.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.429.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.429.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.429.error.quota.region` (string, optional) - `CreateDomain.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.429.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.429.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 500 internal_error: a bug; the details are in the logs, under the request ID. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.500.error` (object, required) - `CreateDomain.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.500.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.500.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.500.error.issues.message` (string, required) - `CreateDomain.response.500.error.issues.path` (string, required) - `CreateDomain.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.500.error.quota.id` (string, required) - `CreateDomain.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.500.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.500.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.500.error.quota.region` (string, optional) - `CreateDomain.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.500.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.500.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 503 unavailable: a dependency the request needs is down. Retry after Retry-After. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `CreateDomain.response.503.error` (object, required) - `CreateDomain.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `CreateDomain.response.503.error.message` (string, required) - maxLength 1024 - `CreateDomain.response.503.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `CreateDomain.response.503.error.issues.message` (string, required) - `CreateDomain.response.503.error.issues.path` (string, required) - `CreateDomain.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `CreateDomain.response.503.error.quota.id` (string, required) - `CreateDomain.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `CreateDomain.response.503.error.quota.limit` (integer, required) - min 0 - `CreateDomain.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `CreateDomain.response.503.error.quota.inFlight` (integer, optional) - min 0 - `CreateDomain.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `CreateDomain.response.503.error.quota.region` (string, optional) - `CreateDomain.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `CreateDomain.response.503.error.quota.scopeResourceName` (string, optional) - `CreateDomain.response.503.error.quota.used` (integer, optional) - min 0 - `CreateDomain.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. Source: https://docs.ezghcloud.com/sso-api/CreateDomain/index.md