Class: Aws::CognitoIdentityProvider::Types::UsernameConfigurationType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UsernameConfigurationType
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
The username configuration type.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#case_sensitive ⇒ Boolean
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
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 usingusername
,USERNAME
, orUserName
. This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.
10654 10655 10656 10657 10658 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10654 class UsernameConfigurationType < Struct.new( :case_sensitive) SENSITIVE = [] include Aws::Structure end |