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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass UsernameConfigurationType data as a hash:

{
  case_sensitive: false, # required
}

The username configuration type.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #case_sensitive ⇒ Boolean

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

Instance Attribute Details

#case_sensitive ⇒ Boolean

Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon 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, 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 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)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10702

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