--- title: "Return a list of domains for a subscription." method: GET path: "/subscriptions/{subscriptionId}/sso-domains" tags: ["Domains"] --- # Return a list of domains for a subscription. `GET /subscriptions/{subscriptionId}/sso-domains` ## Request - Base URL: `https://api.acquia.com/v3` - URL: `https://api.acquia.com/v3/subscriptions/{subscriptionId}/sso-domains` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `subscriptionId` string, required ## Query parameters - `offset` integer - `limit` integer - `sort` string - `filter` string ## Response `200` OK - object - `_links` object, required: HAL links for the resource - `self` FederatedAuthenticationAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `prev` FederatedAuthenticationAPIHalLink: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `next` FederatedAuthenticationAPIHalLink: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `offset` object: Templated link for offset - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` true, required: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `limit` object: Templated link for limit - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` true, required: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `filter` object: Templated link for filtering. The `filter` query parameter is a string to signify the fields to filter the result set by. If the filter includes logical filters this string will be delimited by a "," for a logical OR filter, or a ";" for logical AND filters. Note: Only one type logical filter will be accepted. If the filter contains both OR and AND filters it will be rejected. (e.g. filter=field=value*;field2=value2* indicates that the result set will be filtered by "field" using the term "value*" AND "field2" using the term "value2*". Note that * is a wildcard character in this context). Allowed filter operators are: Equals: = (%3D), Does not equal: != (!%3D), Greater than: > (%3E), Less than: < (%3C), Greater than or equal to: >= (%3E%3D), Less than or equal to: <= (%3C%3D), Contains substring: =@ (%3D@), Does not contain substring: !@ (!@) - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` true, required: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `sort` object: Templated link for sorting. The `sort` query parameter is a comma-delimited string with fields that are used for sorting. The order of fields is significant. A leading "-" in the field name indicates the field should be sorted in descending order. (e.g. sort=field,-field2 indicates that the result set will be sorted by "field" in ascending order, then by "field2" in descending order.) - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` true, required: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `_embedded` object, required: Embedded resources for the collection - `items` object[], required: The array of resources in the collection - `domain_id` string, required: Unique identifier for the domain. - `domain` string, required: The domain name (e.g., "acme.com"). - `subscription_id` string, required: Unique identifier for the subscription that the domain belongs to. - `health` object, required: The overall verification health of the domain. Uses the same code semantics as the platform email domain-verification system: `200` verified, `202` verification pending or in progress, `404` DNS record not found or could not be validated. - `code` '200' | '202' | '404', required: Machine-readable verification status code. `200` — verified. `202` — verification pending or in progress; retry after propagation. `404` — DNS TXT record not found or does not match expected value. - `summary` string, required: Short human-readable label for the verification state (e.g., "Verified", "Verification pending", "Missing DNS record"). - `details` string, required: Actionable explanation of the current state. For `404`, describes what was checked and what the customer should do next. - `verification_record` object, required: DNS TXT record the customer must publish to verify domain ownership. - `type` 'TXT', required: DNS record type. - `host` string, required: DNS record host name. - `value` string, required: Expected DNS record value. - `health` object, required: Verification health specific to this DNS record. Anchors the failure reason to the exact record the customer needs to fix, matching the per-record health pattern used in platform email domain verification. - `code` '200' | '202' | '404', required: `200` — record found and value matches. `202` — check in progress. `404` — record not found or value does not match. - `summary` string, required: Short human-readable label for this record's verification state. - `details` string, required: Actionable explanation; for `404`, states what was checked and what to fix. - `verified_at` string, date-time: Timestamp when the domain was successfully verified. Present only when `health.code` is `200`. - `_links` object, required: HAL links for the resource - `self` FederatedAuthenticationAPIHalLink, required: HAL link object - `href` union, required: The target URI of the link (can be a URI or URI template) - string, uri - string, uri-template - `templated` boolean: Whether the link is a URI template - `type` string: Hint about the media type expected when dereferencing the target resource - `deprecation` string: A URL to a resource that provides deprecation information - `name` string: A secondary key for selecting links - `profile` string: A URI that hints about the profile of the target resource - `title` string: A human-readable identifier for the link - `hreflang` string: The language of the target resource - `_embedded` object: Embedded resources (optional) - `count` integer, required: The number of items in the current page - `total` integer, required: The total number of items available - `pagination` object, required - `total` integer, required: The total number of items available - `limit` integer, required: The maximum number of items to retrieve in a single page - `offset` integer, required: The starting position of the items to retrieve ## Other responses - `400`: Validation Error - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api.md) - [All operations](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/revisions/508f8f94456d?raw)