AdminInitiateAuthResponse
Initiates the authentication response, as an administrator.
Types
Properties
The outcome of successful authentication. This is only returned if the user pool has no additional challenges to return. If Amazon Cognito returns another challenge, the response includes ChallengeName
, ChallengeParameters
, and Session
so that your user can answer the challenge.
This response parameter lists the available authentication challenges that users can select from in choice-based authentication. For example, they might be able to choose between passkey authentication, a one-time password from an SMS message, and a traditional password.
The name of the challenge that you're responding to with this call. This is returned in the AdminInitiateAuth
response if you must pass another challenge.
The parameters of an authentication challenge. Amazon Cognito returns challenge parameters as a guide to the responses your user or application must provide for the returned ChallengeName
. Calculate responses to the challenge parameters and pass them in the ChallengeParameters
of AdminRespondToAuthChallenge
.
The session that must be passed to challenge-response requests. If an AdminInitiateAuth
or AdminRespondToAuthChallenge
API request results in another authentication challenge, Amazon Cognito returns a session ID and the parameters of the next challenge. Pass this session ID in the Session
parameter of AdminRespondToAuthChallenge
.