Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class InitiateAuthResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.cognitoidentityprovider.model.InitiateAuthResponse

All Implemented Interfaces:

ToCopyableBuilder<InitiateAuthResponse.Builder,InitiateAuthResponse>

@Generated("software.amazon.awssdk:codegen")
public class InitiateAuthResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<InitiateAuthResponse.Builder,InitiateAuthResponse>

Initiates the authentication response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InitiateAuthResponse.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationResultType	authenticationResult()	The result of the authentication response.
static InitiateAuthResponse.Builder	builder()
String	challengeName()	The name of the challenge which you are responding to with this call.
Map<String,String>	challengeParameters()	The challenge parameters.
boolean	equals(Object obj)
int	hashCode()
static Class<? extends InitiateAuthResponse.Builder>	serializableBuilderClass()
String	session()	The session which should be passed both ways in challenge-response calls to the service.
InitiateAuthResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

challengeName

public String challengeName()

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.

Valid values include the following. Note that all of these challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.

• 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.

• NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

Returns:

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.

Valid values include the following. Note that all of these challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.

• 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.

• NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

See Also:

ChallengeNameType

session

public String session()

The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge 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 RespondToAuthChallenge API call.

Returns:

The session which should be passed both ways in challenge-response calls to the service. If the InitiateAuth or RespondToAuthChallenge 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 RespondToAuthChallenge API call.

challengeParameters

public Map<String,String> challengeParameters()

The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call ( RespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

Returns:

The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

authenticationResult

public AuthenticationResultType authenticationResult()

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.

Returns:

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.

toBuilder

public InitiateAuthResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InitiateAuthResponse.Builder,InitiateAuthResponse>

Returns:

a builder for type T

builder

public static InitiateAuthResponse.Builder builder()

serializableBuilderClass

public static Class<? extends InitiateAuthResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object