software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminInitiateAuthRequest.Builder

All Superinterfaces:

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

Enclosing class:

AdminInitiateAuthRequest

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

Method Summary

Modifier and Type	Method and Description
AdminInitiateAuthRequest.Builder	analyticsMetadata(AnalyticsMetadataType analyticsMetadata) The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
default AdminInitiateAuthRequest.Builder	analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
AdminInitiateAuthRequest.Builder	authFlow(AuthFlowType authFlow) The authentication flow for this call to execute.
AdminInitiateAuthRequest.Builder	authFlow(String authFlow) The authentication flow for this call to execute.
AdminInitiateAuthRequest.Builder	authParameters(Map<String,String> authParameters) The authentication parameters.
AdminInitiateAuthRequest.Builder	clientId(String clientId) The app client ID.
AdminInitiateAuthRequest.Builder	clientMetadata(Map<String,String> clientMetadata) This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is.
default AdminInitiateAuthRequest.Builder	contextData(Consumer<ContextDataType.Builder> contextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
AdminInitiateAuthRequest.Builder	contextData(ContextDataType contextData) Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
AdminInitiateAuthRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
AdminInitiateAuthRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
AdminInitiateAuthRequest.Builder	userPoolId(String userPoolId) The ID of the Amazon Cognito user pool.

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

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

userPoolId

AdminInitiateAuthRequest.Builder userPoolId(String userPoolId)

The ID of the Amazon Cognito user pool.

Parameters:

userPoolId - The ID of the Amazon Cognito user pool.

Returns:

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

clientId

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

authFlow

AdminInitiateAuthRequest.Builder authFlow(String authFlow)

The authentication flow for this call to execute. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

• USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

• CUSTOM_AUTH: Custom authentication flow.

• ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.

Parameters:

authFlow - The authentication flow for this call to execute. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

• USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

• CUSTOM_AUTH: Custom authentication flow.

• ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.

Returns:

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

See Also:

AuthFlowType, AuthFlowType

authFlow

AdminInitiateAuthRequest.Builder authFlow(AuthFlowType authFlow)

The authentication flow for this call to execute. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

• USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

• CUSTOM_AUTH: Custom authentication flow.

• ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.

Parameters:

authFlow - The authentication flow for this call to execute. The API action will depend on this value. For example:

• REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

• USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

• USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

• REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

• CUSTOM_AUTH: Custom authentication flow.

• ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.

Returns:

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

See Also:

AuthFlowType, AuthFlowType

authParameters

AdminInitiateAuthRequest.Builder authParameters(Map<String,String> authParameters)

The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

• For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

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

• For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

Parameters:

authParameters - The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

• For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

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

• For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

Returns:

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

clientMetadata

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

This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.

Parameters:

clientMetadata - This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.

Returns:

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

analyticsMetadata

AdminInitiateAuthRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

Parameters:

analyticsMetadata - The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

Returns:

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

analyticsMetadata

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

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

This is a convenience 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)

contextData

AdminInitiateAuthRequest.Builder contextData(ContextDataType contextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Parameters:

contextData - Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Returns:

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

contextData

default AdminInitiateAuthRequest.Builder contextData(Consumer<ContextDataType.Builder> contextData)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

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

Parameters:

contextData - a consumer that will call methods on ContextDataType.Builder

Returns:

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

See Also:

contextData(ContextDataType)

overrideConfiguration

AdminInitiateAuthRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.