Amazon Cognito · Schema

UsernameConfigurationType

The username configuration type.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

Name Type Description
CaseSensitive object
View JSON Schema on GitHub

JSON Schema

cognito-idp-username-configuration-type-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "CaseSensitive": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrappedBooleanType"
        },
        {
          "description": "<p>Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.</p> <p>Valid values include:</p> <dl> <dt>True</dt> <dd> <p>Enables case sensitivity for all username input. When this option is set to <code>True</code>, users must sign in using the exact capitalization of their given username, such as \u201cUserName\u201d. This is the default value.</p> </dd> <dt>False</dt> <dd> <p>Enables case insensitivity for all username input. For example, when this option is set to <code>False</code>, users can sign in using either \"username\" or \"Username\". This option also enables both <code>preferred_username</code> and <code>email</code> alias to be case insensitive, in addition to the <code>username</code> attribute.</p> </dd> </dl>"
        }
      ]
    }
  },
  "required": [
    "CaseSensitive"
  ],
  "description": "The username configuration type. ",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-username-configuration-type-schema.json",
  "title": "UsernameConfigurationType"
}