Amazon Cognito · JSON Structure

Cognito Idp Create User Pool Domain Request Structure

CreateUserPoolDomainRequest schema from Amazon Cognito

Type: object Properties: 3 Required: 2
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

CreateUserPoolDomainRequest is a JSON Structure definition published by Amazon Cognito, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Domain UserPoolId CustomDomainConfig

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

JSON Structure

Raw ↑
{
  "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>."
        }
      ]
    },
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    },
    "CustomDomainConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomDomainConfigType"
        },
        {
          "description": "<p>The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.</p> <p>Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.</p> <p>For more information about the hosted domain and custom domains, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html\">Configuring a User Pool Domain</a>.</p>"
        }
      ]
    }
  },
  "required": [
    "Domain",
    "UserPoolId"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-create-user-pool-domain-request-structure.json",
  "name": "CreateUserPoolDomainRequest",
  "description": "CreateUserPoolDomainRequest schema from Amazon Cognito"
}