Domains

Return details about a specific domain.

get/sso-domains/{domainId}

Request

Path parameters

domainIdstring required

Unique identifier for the domain.

Response

OK. The _links object always contains self. Additional links are state-conditional: verify is present when health.code is 202 or 404 (POST it to initiate or retry DNS TXT record verification); identity_providers is present when the domain is referenced by one or more Identity Provider policies (follows to a filtered list of those IdPs; when present the domain cannot be deleted — remove it from all policies first).

domain_idstring required

Unique identifier for the domain.

domainstring required

The domain name (e.g., "acme.com").

subscription_idstring required

Unique identifier for the subscription that the domain belongs to.

verified_atstring date-time

Timestamp when the domain was successfully verified. Present only when health.code is 200.

_embeddedobject

Embedded resources (optional)

Example response

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.