amplify-ui icon indicating copy to clipboard operation
amplify-ui copied to clipboard

Documentation update: add documentation showing how to configure a cognito password policy in `Amplify.configure`

Open jackirvine97 opened this issue 1 year ago • 0 comments

On which framework/platform would you like to see this feature implemented?

React, Angular

Which UI component is this feature-request for?

Authenticator

Please describe your feature-request in detail.

A cognito password policy can be added to an Amplify.configure() call as follow:

Amplify.configure({
    aws_cognito_password_protection_settings: {
        passwordPolicyMinLength: 8,
        passwordPolicyCharacters: [
            "REQUIRES_LOWERCASE",
            "REQUIRES_NUMBERS",
            "REQUIRES_SYMBOLS",
            "REQUIRES_UPPERCASE",
        ],
    },
    Auth: {
        region: awsExports.REGION,
        userPoolId: awsExports.USER_POOL_ID,
        userPoolWebClientId: awsExports.USER_POOL_APP_CLIENT_ID,
    },
})

This automatically passes your password policy to a the password input field in the Authenticator component.

The problem - this straightforward pattern is not mentioned in the documentation!

Please describe a solution you'd like.

Please add a reference to this in the documentation!

We love contributors! Is this something you'd be interested in working on?

  • [ ] 👋 I may be able to implement this feature request.
  • [ ] ⚠️ This feature might incur a breaking change.

jackirvine97 avatar Sep 07 '23 18:09 jackirvine97