Amazon Cognito · JSON Structure

User Pools Describe User Pool Domain Request Structure

DescribeUserPoolDomainRequest schema from Amazon Cognito API

Type: object Properties: 1 Required: 1
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

DescribeUserPoolDomainRequest is a JSON Structure definition published by Amazon Cognito, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Domain

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-describe-user-pool-domain-request-structure.json",
  "name": "DescribeUserPoolDomainRequest",
  "description": "DescribeUserPoolDomainRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "Domain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainType"
        },
        {
          "description": "The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>."
        }
      ]
    }
  },
  "required": [
    "Domain"
  ]
}