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

Interface AdminInitiateAuthRequest.Builder

All Superinterfaces:

CopyableBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>, SdkBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>

Enclosing class:

AdminInitiateAuthRequest

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

Method Summary

Modifier and Type	Method	Description
AdminInitiateAuthRequest.Builder	authFlow(String authFlow)	The authentication flow for this call to execute.
AdminInitiateAuthRequest.Builder	authFlow(AuthFlowType 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.
AdminInitiateAuthRequest.Builder	userPoolId(String userPoolId)	The ID of the Amazon Cognito user pool.

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

copy

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

apply, 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 SRPA and return the SRP variables to be used for next challenge execution.

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.

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 SRPA and return the SRP variables to be used for next challenge execution.

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.

Returns:

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

See Also:

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 SRPA and return the SRP variables to be used for next challenge execution.

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.

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 SRPA and return the SRP variables to be used for next challenge execution.

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.

Returns:

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

See Also:

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), SRPA (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), 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), SRPA (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

• For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: USERNAME (required), SECRET_HASH (required if the app client is configured with a client secret), REFRESH_TOKEN (required), 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.