Amazon Cognito · JSON Structure

Cognito Idp User Pool Client Description Structure

The description of the user pool client.

Type: object Properties: 3
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

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

Properties

ClientId UserPoolId ClientName

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "ClientId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientIdType"
        },
        {
          "description": "The ID of the client associated with the user pool."
        }
      ]
    },
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool where you want to describe the user pool client."
        }
      ]
    },
    "ClientName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientNameType"
        },
        {
          "description": "The client name from the user pool client description."
        }
      ]
    }
  },
  "description": "The description of the user pool client.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-user-pool-client-description-structure.json",
  "name": "UserPoolClientDescription"
}