You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentityProvider::Types::UsernameConfigurationType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UsernameConfigurationType
- Defined in:
- (unknown)
Overview
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:
Instance Attribute Summary collapse
-
#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 toTrue
, 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 toFalse
, users will be able to sign in using either \"username\" or \"Username\". This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.