Skip to content

Commit e06d2e6

Browse files
authored
docs(cognito): update user pool example with case insensitive sign in (#22462)
Making usernames case insensitive in basic example because that is preferred in most situations. ---- ### All Submissions: * [Y] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [N] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [N] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 4cb008b commit e06d2e6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

packages/@aws-cdk/aws-cognito/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,15 @@ the `userPoolName` to give your own identifier to the user pool. If not, CloudFo
6666
```ts
6767
new cognito.UserPool(this, 'myuserpool', {
6868
userPoolName: 'myawesomeapp-userpool',
69+
signInCaseSensitive: false, // case insensitive is preferred in most situations
6970
});
7071
```
7172

73+
By default, usernames and email addresses in user pools are case sensitive, which means `[email protected]` and `[email protected]`
74+
are considered different. In most situations it is prefered to have usernames and email addresses be case insensitive so that
75+
capitalization differences are ignored. As shown above, you can make a user pool case insensitive by setting `signInCaseSensitive`
76+
to `false`. The case sensitivity cannot be changed once a user pool is created.
77+
7278
The default set up for the user pool is configured such that only administrators will be allowed
7379
to create users. Features such as Multi-factor authentication (MFAs) and Lambda Triggers are not
7480
configured by default.

0 commit comments

Comments
 (0)