---
title: "Get a custom domain"
---

> 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

`GET /v1/organizations/{orgId}/sso/custom-domains/{hostname}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `GetCustomDomain.path.orgId` (string, required)
  - format `uuid`
- `GetCustomDomain.path.hostname` (string, required)

## Code samples

### cURL

```curl
curl --request GET \
  --url https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/custom-domains/string \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/custom-domains/string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/custom-domains/string"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The custom domain.

#### Example

```json
{
  "activatedAt": "2019-08-24T14:15:22Z",
  "certificate": {
    "error": "string",
    "notAfter": "2019-08-24T14:15:22Z"
  },
  "checkError": "string",
  "checkRequestedAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
  "hostname": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "issuer": "http://example.com",
  "lastCheckedAt": "2019-08-24T14:15:22Z",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "records": [
    {
      "found": true,
      "purpose": "ownership",
      "recordName": "string",
      "recordType": "TXT",
      "recordValue": "string"
    }
  ],
  "status": "pending",
  "updatedAt": "2019-08-24T14:15:22Z",
  "verifiedAt": "2019-08-24T14:15:22Z"
}
```

- `GetCustomDomain.response.200.activatedAt` (string | null, required)
  - format `date-time`
- `GetCustomDomain.response.200.certificate` (object, required)
  - `GetCustomDomain.response.200.certificate.error` (string | null, required) — Why the certificate isn't issued or attached yet, as cert-manager or the Gateway reports it.
  - `GetCustomDomain.response.200.certificate.notAfter` (string | null, required) — When the hostname's certificate expires; cert-manager renews it ahead of time.
    - format `date-time`
- `GetCustomDomain.response.200.checkError` (string | null, required)
- `GetCustomDomain.response.200.checkRequestedAt` (string | null, required)
  - format `date-time`
- `GetCustomDomain.response.200.createdAt` (string, required)
  - format `date-time`
- `GetCustomDomain.response.200.directoryId` (string, required)
  - format `uuid`
- `GetCustomDomain.response.200.hostname` (string, required) — Lowercase ASCII; an internationalized name in its xn-- form.
- `GetCustomDomain.response.200.id` (string, required)
  - format `uuid`
- `GetCustomDomain.response.200.issuer` (string, required) — https://<hostname>: the OIDC issuer on this hostname (and the base of its SAML entity IDs), live while active. The directory's own issuer keeps working.
  - format `uri`
- `GetCustomDomain.response.200.lastCheckedAt` (string | null, required)
  - format `date-time`
- `GetCustomDomain.response.200.organizationId` (string, required)
  - format `uuid`
- `GetCustomDomain.response.200.records` (array<object>, required) — The TXT record (purpose ownership), then the CNAME (purpose routing).
  - `GetCustomDomain.response.200.records.found` (boolean | null, required) — Whether the last check found the record; null until a lookup answered.
  - `GetCustomDomain.response.200.records.purpose` (string, required)
    - one of `"ownership"`, `"routing"`
  - `GetCustomDomain.response.200.records.recordName` (string, required) — _ezgh-sso-verification.<hostname> for the TXT record; the hostname for the CNAME.
  - `GetCustomDomain.response.200.records.recordType` (string, required)
    - one of `"TXT"`, `"CNAME"`
  - `GetCustomDomain.response.200.records.recordValue` (string, required) — ezgh-sso-verification=<token> for the TXT record; <alias>.sso.ezgh.app for the CNAME.
- `GetCustomDomain.response.200.status` (string, required) — pending until sso-worker finds both records; issuing while the certificate is issued and attached to the Gateway; active once sso-edge serves the hostname. Two consecutive misses of either record make an issuing or active domain pending again, and it stops being served.
  - one of `"pending"`, `"issuing"`, `"active"`
- `GetCustomDomain.response.200.updatedAt` (string, required)
  - format `date-time`
- `GetCustomDomain.response.200.verifiedAt` (string | null, required) — When both records were found.
  - 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"
    }
  }
}
```

- `GetCustomDomain.response.400.error` (object, required)
  - `GetCustomDomain.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetCustomDomain.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetCustomDomain.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetCustomDomain.response.400.error.issues.message` (string, required)
    - `GetCustomDomain.response.400.error.issues.path` (string, required)
  - `GetCustomDomain.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetCustomDomain.response.400.error.quota.id` (string, required)
    - `GetCustomDomain.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetCustomDomain.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetCustomDomain.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetCustomDomain.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetCustomDomain.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.400.error.quota.region` (string, optional)
    - `GetCustomDomain.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetCustomDomain.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetCustomDomain.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"
    }
  }
}
```

- `GetCustomDomain.response.401.error` (object, required)
  - `GetCustomDomain.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetCustomDomain.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetCustomDomain.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetCustomDomain.response.401.error.issues.message` (string, required)
    - `GetCustomDomain.response.401.error.issues.path` (string, required)
  - `GetCustomDomain.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetCustomDomain.response.401.error.quota.id` (string, required)
    - `GetCustomDomain.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetCustomDomain.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetCustomDomain.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetCustomDomain.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetCustomDomain.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.401.error.quota.region` (string, optional)
    - `GetCustomDomain.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetCustomDomain.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetCustomDomain.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"
    }
  }
}
```

- `GetCustomDomain.response.403.error` (object, required)
  - `GetCustomDomain.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetCustomDomain.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetCustomDomain.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetCustomDomain.response.403.error.issues.message` (string, required)
    - `GetCustomDomain.response.403.error.issues.path` (string, required)
  - `GetCustomDomain.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetCustomDomain.response.403.error.quota.id` (string, required)
    - `GetCustomDomain.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetCustomDomain.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetCustomDomain.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetCustomDomain.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetCustomDomain.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.403.error.quota.region` (string, optional)
    - `GetCustomDomain.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetCustomDomain.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetCustomDomain.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"
    }
  }
}
```

- `GetCustomDomain.response.404.error` (object, required)
  - `GetCustomDomain.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetCustomDomain.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetCustomDomain.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetCustomDomain.response.404.error.issues.message` (string, required)
    - `GetCustomDomain.response.404.error.issues.path` (string, required)
  - `GetCustomDomain.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetCustomDomain.response.404.error.quota.id` (string, required)
    - `GetCustomDomain.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetCustomDomain.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetCustomDomain.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetCustomDomain.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetCustomDomain.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.404.error.quota.region` (string, optional)
    - `GetCustomDomain.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetCustomDomain.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetCustomDomain.response.404.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"
    }
  }
}
```

- `GetCustomDomain.response.429.error` (object, required)
  - `GetCustomDomain.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetCustomDomain.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetCustomDomain.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetCustomDomain.response.429.error.issues.message` (string, required)
    - `GetCustomDomain.response.429.error.issues.path` (string, required)
  - `GetCustomDomain.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetCustomDomain.response.429.error.quota.id` (string, required)
    - `GetCustomDomain.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetCustomDomain.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetCustomDomain.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetCustomDomain.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetCustomDomain.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.429.error.quota.region` (string, optional)
    - `GetCustomDomain.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetCustomDomain.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetCustomDomain.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"
    }
  }
}
```

- `GetCustomDomain.response.500.error` (object, required)
  - `GetCustomDomain.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetCustomDomain.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetCustomDomain.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetCustomDomain.response.500.error.issues.message` (string, required)
    - `GetCustomDomain.response.500.error.issues.path` (string, required)
  - `GetCustomDomain.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetCustomDomain.response.500.error.quota.id` (string, required)
    - `GetCustomDomain.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetCustomDomain.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetCustomDomain.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetCustomDomain.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetCustomDomain.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.500.error.quota.region` (string, optional)
    - `GetCustomDomain.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetCustomDomain.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetCustomDomain.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"
    }
  }
}
```

- `GetCustomDomain.response.503.error` (object, required)
  - `GetCustomDomain.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetCustomDomain.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetCustomDomain.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetCustomDomain.response.503.error.issues.message` (string, required)
    - `GetCustomDomain.response.503.error.issues.path` (string, required)
  - `GetCustomDomain.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetCustomDomain.response.503.error.quota.id` (string, required)
    - `GetCustomDomain.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetCustomDomain.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetCustomDomain.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetCustomDomain.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetCustomDomain.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.503.error.quota.region` (string, optional)
    - `GetCustomDomain.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetCustomDomain.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetCustomDomain.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetCustomDomain.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/sso-api/GetCustomDomain/index.md