interface AuthFlow
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.AuthFlow |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#AuthFlow |
![]() | software.amazon.awscdk.services.cognito.AuthFlow |
![]() | aws_cdk.aws_cognito.AuthFlow |
![]() | aws-cdk-lib » aws_cognito » AuthFlow |
Types of authentication flow.
Example
const userPool = new cognito.UserPool(this, 'myuserpool', {
signInPolicy: {
allowedFirstAuthFactors: {
password: true, // password authentication must be enabled
emailOtp: true, // enables email message one-time password
smsOtp: true, // enables SMS message one-time password
passkey: true, // enables passkey sign-in
},
},
});
// You should also configure the user pool client with USER_AUTH authentication flow allowed
userPool.addClient('myclient', {
authFlows: { user: true },
});
Properties
Name | Type | Description |
---|---|---|
admin | boolean | Enable admin based user password authentication flow. |
custom? | boolean | Enable custom authentication flow. |
user? | boolean | Enable Choice-based authentication. |
user | boolean | Enable auth using username & password. |
user | boolean | Enable SRP based authentication. |
adminUserPassword?
Type:
boolean
(optional, default: false)
Enable admin based user password authentication flow.
custom?
Type:
boolean
(optional, default: false)
Enable custom authentication flow.
user?
Type:
boolean
(optional, default: false)
Enable Choice-based authentication.
userPassword?
Type:
boolean
(optional, default: false)
Enable auth using username & password.
userSrp?
Type:
boolean
(optional, default: false)
Enable SRP based authentication.