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

Class AdminRespondToAuthChallengeRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.AdminRespondToAuthChallengeRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<AdminRespondToAuthChallengeRequest.Builder,AdminRespondToAuthChallengeRequest>

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

The request to respond to the authentication challenge, as an administrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdminRespondToAuthChallengeRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static AdminRespondToAuthChallengeRequest.Builder	builder()
String	challengeName()	The challenge name.
Map<String,String>	challengeResponses()	The challenge responses.
String	clientId()	The app client ID.
boolean	equals(Object obj)
int	hashCode()
static Class<? extends AdminRespondToAuthChallengeRequest.Builder>	serializableBuilderClass()
String	session()	The session which should be passed both ways in challenge-response calls to the service.
AdminRespondToAuthChallengeRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId()	The ID of the Amazon Cognito user pool.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

userPoolId

public String userPoolId()

The ID of the Amazon Cognito user pool.

Returns:

The ID of the Amazon Cognito user pool.

clientId

public String clientId()

The app client ID.

Returns:

The app client ID.

challengeName

public String challengeName()

The challenge name. For more information, see AdminInitiateAuth.

Returns:

The challenge name. For more information, see AdminInitiateAuth.

See Also:

ChallengeNameType

challengeResponses

public Map<String,String> challengeResponses()

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

• ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

Returns:

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

• SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

• ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

session

public String session()

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

toBuilder

public AdminRespondToAuthChallengeRequest.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<AdminRespondToAuthChallengeRequest.Builder,AdminRespondToAuthChallengeRequest>

Returns:

a builder for type T

builder

public static AdminRespondToAuthChallengeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AdminRespondToAuthChallengeRequest.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