 |
|
| |
Paws::CognitoIdp::AdminInitiateAuthResponse(3) |
User Contributed Perl Documentation |
Paws::CognitoIdp::AdminInitiateAuthResponse(3) |
Paws::CognitoIdp::AdminInitiateAuthResponse
The result of the authentication response. This is only returned
if the caller does not need to pass another challenge. If the caller does
need to pass another challenge before it gets tokens,
"ChallengeName",
"ChallengeParameters", and
"Session" are returned.
The name of the challenge which you are responding to with this
call. This is returned to you in the
"AdminInitiateAuth" response if you need
to pass another challenge.
- "MFA_SETUP": If MFA is required, users
who do not have at least one of the MFA methods set up are presented with
an "MFA_SETUP" challenge. The user must
set up at least one MFA type to continue to authenticate.
- "SELECT_MFA_TYPE": Selects the MFA type.
Valid MFA options are "SMS_MFA" for text
SMS MFA, and "SOFTWARE_TOKEN_MFA" for
TOTP software token MFA.
- "SMS_MFA": Next challenge is to supply
an "SMS_MFA_CODE", delivered via
SMS.
- "PASSWORD_VERIFIER": Next challenge is
to supply "PASSWORD_CLAIM_SIGNATURE",
"PASSWORD_CLAIM_SECRET_BLOCK", and
"TIMESTAMP" after the client-side SRP
calculations.
- "CUSTOM_CHALLENGE": This is returned if
your custom authentication flow determines that the user should pass
another challenge before tokens are issued.
- "DEVICE_SRP_AUTH": If device tracking
was enabled on your user pool and the previous challenges were passed,
this challenge is returned so that Amazon Cognito can start tracking this
device.
- "DEVICE_PASSWORD_VERIFIER": Similar to
"PASSWORD_VERIFIER", but for devices
only.
- "ADMIN_NO_SRP_AUTH": This is returned if
you need to authenticate with "USERNAME"
and "PASSWORD" directly. An app client
must be enabled to use this flow.
- "NEW_PASSWORD_REQUIRED": For users who
are required to change their passwords after successful first login. This
challenge should be passed with
"NEW_PASSWORD" and any other required
attributes.
- "MFA_SETUP": For users who are required
to setup an MFA factor before they can sign-in. The MFA types enabled for
the user pool will be listed in the challenge parameters
"MFA_CAN_SETUP" value.
To setup software token MFA, use the session returned here
from "InitiateAuth" as an input to
"AssociateSoftwareToken", and use the
session returned by
"VerifySoftwareToken" as an input to
"RespondToAuthChallenge" with
challenge name "MFA_SETUP" to complete
sign-in. To setup SMS MFA, users will need help from an administrator to
add a phone number to their account and then call
"InitiateAuth" again to restart
sign-in.
Valid values are: "SMS_MFA",
"SOFTWARE_TOKEN_MFA",
"SELECT_MFA_TYPE",
"MFA_SETUP",
"PASSWORD_VERIFIER",
"CUSTOM_CHALLENGE",
"DEVICE_SRP_AUTH",
"DEVICE_PASSWORD_VERIFIER",
"ADMIN_NO_SRP_AUTH",
"NEW_PASSWORD_REQUIRED" =head2
ChallengeParameters => Paws::CognitoIdp::ChallengeParametersType
The challenge parameters. These are returned to you in the
"AdminInitiateAuth" response if you need
to pass another challenge. The responses in this parameter should be used to
compute inputs to the next call
("AdminRespondToAuthChallenge").
All challenges require
"USERNAME" and
"SECRET_HASH" (if applicable).
The value of the
"USER_ID_FOR_SRP" attribute will be the
user's actual username, not an alias (such as email address or phone
number), even if you specified an alias in your call to
"AdminInitiateAuth". This is because, in
the "AdminRespondToAuthChallenge" API
"ChallengeResponses", the
"USERNAME" attribute cannot be an
alias.
The session which should be passed both ways in challenge-response
calls to the service. If
"AdminInitiateAuth" or
"AdminRespondToAuthChallenge" API call
determines that the caller needs to go through another challenge, they
return a session with other challenge parameters. This session should be
passed as it is to the next
"AdminRespondToAuthChallenge" API
call.
Visit the GSP FreeBSD Man Page Interface. Output converted with ManDoc.
|