software.amazon.awssdk.services.cognitoidentityprovider.model

Interface RespondToAuthChallengeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>, SdkBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RespondToAuthChallengeRequest

public static interface RespondToAuthChallengeRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<RespondToAuthChallengeRequest.Builder,RespondToAuthChallengeRequest>

Method Summary

Modifier and Type	Method and Description
RespondToAuthChallengeRequest.Builder	analyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.
default RespondToAuthChallengeRequest.Builder	analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.
RespondToAuthChallengeRequest.Builder	challengeName(ChallengeNameType challengeName) The challenge name.
RespondToAuthChallengeRequest.Builder	challengeName(String challengeName) The challenge name.
RespondToAuthChallengeRequest.Builder	challengeResponses(Map<String,String> challengeResponses) The challenge responses.
RespondToAuthChallengeRequest.Builder	clientId(String clientId) The app client ID.
RespondToAuthChallengeRequest.Builder	clientMetadata(Map<String,String> clientMetadata) A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
RespondToAuthChallengeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
RespondToAuthChallengeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
RespondToAuthChallengeRequest.Builder	session(String session) The session that should be passed both ways in challenge-response calls to the service.
default RespondToAuthChallengeRequest.Builder	userContextData(Consumer<UserContextDataType.Builder> userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.
RespondToAuthChallengeRequest.Builder	userContextData(UserContextDataType userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientId

RespondToAuthChallengeRequest.Builder clientId(String clientId)

The app client ID.

Parameters:

clientId - The app client ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

challengeName

RespondToAuthChallengeRequest.Builder challengeName(String challengeName)

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

Parameters:

challengeName - The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChallengeNameType, ChallengeNameType

challengeName

RespondToAuthChallengeRequest.Builder challengeName(ChallengeNameType challengeName)

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

Parameters:

challengeName - The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChallengeNameType, ChallengeNameType

session

RespondToAuthChallengeRequest.Builder session(String session)

The session that should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

Parameters:

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

Returns a reference to this object so that method calls can be chained together.

challengeResponses

RespondToAuthChallengeRequest.Builder challengeResponses(Map<String,String> challengeResponses)

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

SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

• SMS_MFA: SMS_MFA_CODE, USERNAME.

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.

  In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

• SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

• DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

• DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.

• MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

Parameters:

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

SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

• SMS_MFA: SMS_MFA_CODE, USERNAME.

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. This parameter can also set values for writable attributes that aren't required by your user pool.

  In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

• SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

• DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

• DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.

• MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

analyticsMetadata

RespondToAuthChallengeRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.

Parameters:

analyticsMetadata - The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.

Returns:

Returns a reference to this object so that method calls can be chained together.

analyticsMetadata

default RespondToAuthChallengeRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)

The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.

This is a convenience method that creates an instance of the AnalyticsMetadataType.Builder avoiding the need to create one manually via AnalyticsMetadataType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analyticsMetadata(AnalyticsMetadataType).

Parameters:

analyticsMetadata - a consumer that will call methods on AnalyticsMetadataType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

analyticsMetadata(AnalyticsMetadataType)

userContextData

RespondToAuthChallengeRequest.Builder userContextData(UserContextDataType userContextData)

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Parameters:

userContextData - Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

Returns:

Returns a reference to this object so that method calls can be chained together.

userContextData

default RespondToAuthChallengeRequest.Builder userContextData(Consumer<UserContextDataType.Builder> userContextData)

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

This is a convenience method that creates an instance of the UserContextDataType.Builder avoiding the need to create one manually via UserContextDataType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userContextData(UserContextDataType).

Parameters:

userContextData - a consumer that will call methods on UserContextDataType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

userContextData(UserContextDataType)

clientMetadata

RespondToAuthChallengeRequest.Builder clientMetadata(Map<String,String> clientMetadata)

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Parameters:

clientMetadata - A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

RespondToAuthChallengeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

RespondToAuthChallengeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder