authParameters
The authentication parameters. These are inputs corresponding to the AuthFlow
that you're invoking. The required values depend on the value of AuthFlow
:
For
USER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.For
USER_PASSWORD_AUTH
:USERNAME
(required),PASSWORD
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.For
REFRESH_TOKEN_AUTH/REFRESH_TOKEN
:REFRESH_TOKEN
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
.For
CUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
. To start the authentication flow with password verification, includeChallengeName: SRP_A
andSRP_A: (The SRP_A Value)
.
For more information about SECRET_HASH
, see Computing secret hash values. For information about DEVICE_KEY
, see Working with user devices in your user pool.