software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminInitiateAuthResponse.Builder

All Superinterfaces:

CognitoIdentityProviderResponse.Builder, CopyableBuilder<AdminInitiateAuthResponse.Builder,AdminInitiateAuthResponse>, SdkBuilder<AdminInitiateAuthResponse.Builder,AdminInitiateAuthResponse>

Enclosing class:

AdminInitiateAuthResponse

public static interface AdminInitiateAuthResponse.Builder
extends CognitoIdentityProviderResponse.Builder, CopyableBuilder<AdminInitiateAuthResponse.Builder,AdminInitiateAuthResponse>

Method Summary

Modifier and Type	Method and Description
AdminInitiateAuthResponse.Builder	authenticationResult(AuthenticationResultType authenticationResult) The result of the authentication response.
default AdminInitiateAuthResponse.Builder	authenticationResult(Consumer<AuthenticationResultType.Builder> authenticationResult) The result of the authentication response.
AdminInitiateAuthResponse.Builder	challengeName(ChallengeNameType challengeName) The name of the challenge which you are responding to with this call.
AdminInitiateAuthResponse.Builder	challengeName(String challengeName) The name of the challenge which you are responding to with this call.
AdminInitiateAuthResponse.Builder	challengeParameters(Map<String,String> challengeParameters) The challenge parameters.
AdminInitiateAuthResponse.Builder	session(String session) The session which should be passed both ways in challenge-response calls to the service.

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

build

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

challengeName

AdminInitiateAuthResponse.Builder challengeName(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.

• 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 which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

Parameters:

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.

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

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

See Also:

ChallengeNameType, ChallengeNameType

challengeName

AdminInitiateAuthResponse.Builder challengeName(ChallengeNameType 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.

• 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 which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

Parameters:

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.

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

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

See Also:

ChallengeNameType, ChallengeNameType

session

AdminInitiateAuthResponse.Builder session(String session)

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.

Parameters:

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

Returns:

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

challengeParameters

AdminInitiateAuthResponse.Builder challengeParameters(Map<String,String> challengeParameters)

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

Parameters:

challengeParameters - 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_IF_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.

Returns:

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

authenticationResult

AdminInitiateAuthResponse.Builder authenticationResult(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.

Parameters:

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:

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

authenticationResult

default AdminInitiateAuthResponse.Builder authenticationResult(Consumer<AuthenticationResultType.Builder> 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.

This is a convenience that creates an instance of the AuthenticationResultType.Builder avoiding the need to create one manually via AuthenticationResultType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authenticationResult(AuthenticationResultType).

Parameters:

authenticationResult - a consumer that will call methods on AuthenticationResultType.Builder

Returns:

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

See Also:

authenticationResult(AuthenticationResultType)