Class: Aws::CognitoIdentityProvider::Types::UsernameConfigurationType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UsernameConfigurationType

Defined in:

(unknown)

Overview

Note:

When passing UsernameConfigurationType as input to an Aws::Client method, you can use a vanilla Hash:

{
  case_sensitive: false, # required
}

The username configuration type.

Returned by:

• CreateUserPoolRequest#username_configuration
• Aws::CognitoIdentityProvider::Types::UserPoolType#username_configuration

See Also:

• AWS API Documentation

Instance Attribute Summary

• #case_sensitive ⇒ Boolean

  Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

Instance Attribute Details

#case_sensitive ⇒ Boolean

Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.

Valid values include:

• True : Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username. For example, “UserName”. This is the default value.

• False : Enables case insensitivity for all username input. For example, when this option is set to False, users will be able to sign in using either \"username\" or \"Username\". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

Returns:

• (Boolean) —

  Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.