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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The configuration of a user pool for username case sensitivity.

This data type is a request and response parameter of

CreateUserPool][1

and [UpdateUserPool], and a response parameter

of [DescribeUserPool].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#case_sensitive ⇒ Boolean

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to ‘False` (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.

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, such as “UserName”. This
is the default value.

false

: Enables case insensitivity for all username input. For example,

when this option is set to `false`, users can sign in using
`username`, `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) 


13313
13314
13315
13316
13317
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 13313

class UsernameConfigurationType < Struct.new(
  :case_sensitive)
  SENSITIVE = []
  include Aws::Structure
end