com.amazonaws.services.cognitoidp.model

Class InitiateAuthRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.InitiateAuthRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InitiateAuthRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Initiates the authentication request.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
InitiateAuthRequest()

Method Summary

Modifier and Type	Method and Description
InitiateAuthRequest	addAuthParametersEntry(String key, String value) Add a single AuthParameters entry
InitiateAuthRequest	addClientMetadataEntry(String key, String value) Add a single ClientMetadata entry
InitiateAuthRequest	clearAuthParametersEntries() Removes all the entries added into AuthParameters.
InitiateAuthRequest	clearClientMetadataEntries() Removes all the entries added into ClientMetadata.
InitiateAuthRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AnalyticsMetadataType	getAnalyticsMetadata() The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
String	getAuthFlow() The authentication flow for this call to run.
Map<String,String>	getAuthParameters() The authentication parameters.
String	getClientId() The app client ID.
Map<String,String>	getClientMetadata() A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
UserContextDataType	getUserContextData() Contextual data about your user session, such as the device fingerprint, IP address, or location.
int	hashCode()
void	setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
void	setAuthFlow(AuthFlowType authFlow) The authentication flow for this call to run.
void	setAuthFlow(String authFlow) The authentication flow for this call to run.
void	setAuthParameters(Map<String,String> authParameters) The authentication parameters.
void	setClientId(String clientId) The app client ID.
void	setClientMetadata(Map<String,String> clientMetadata) A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
void	setUserContextData(UserContextDataType userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.
String	toString() Returns a string representation of this object.
InitiateAuthRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
InitiateAuthRequest	withAuthFlow(AuthFlowType authFlow) The authentication flow for this call to run.
InitiateAuthRequest	withAuthFlow(String authFlow) The authentication flow for this call to run.
InitiateAuthRequest	withAuthParameters(Map<String,String> authParameters) The authentication parameters.
InitiateAuthRequest	withClientId(String clientId) The app client ID.
InitiateAuthRequest	withClientMetadata(Map<String,String> clientMetadata) A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.
InitiateAuthRequest	withUserContextData(UserContextDataType userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InitiateAuthRequest

public InitiateAuthRequest()

Method Detail

setAuthFlow

public void setAuthFlow(String authFlow)

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

Parameters:

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

See Also:

AuthFlowType

getAuthFlow

public String getAuthFlow()

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

Returns:

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

See Also:

AuthFlowType

withAuthFlow

public InitiateAuthRequest withAuthFlow(String authFlow)

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

Parameters:

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

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:

AuthFlowType

setAuthFlow

public void setAuthFlow(AuthFlowType authFlow)

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

Parameters:

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

See Also:

AuthFlowType

withAuthFlow

public InitiateAuthRequest withAuthFlow(AuthFlowType authFlow)

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

ADMIN_NO_SRP_AUTH isn't a valid value.

Parameters:

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

• REFRESH_TOKEN_AUTH takes in a valid refresh token and returns new tokens.

• USER_SRP_AUTH takes in USERNAME and SRP_A and returns the SRP variables to be used for next challenge execution.

• USER_PASSWORD_AUTH takes in USERNAME and PASSWORD and returns 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.

• USER_PASSWORD_AUTH: Non-SRP authentication flow; user name and password are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if it doesn't find the user name in the user pool.

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:

AuthFlowType

getAuthParameters

public Map<String,String> getAuthParameters()

The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

Returns:

The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

setAuthParameters

public void setAuthParameters(Map<String,String> authParameters)

The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

Parameters:

authParameters - The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

withAuthParameters

public InitiateAuthRequest withAuthParameters(Map<String,String> authParameters)

The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

Parameters:

authParameters - The authentication parameters. These are inputs corresponding to the AuthFlow that you're 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 USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY. To start the authentication flow with password verification, include ChallengeName: SRP_A and SRP_A: (The SRP_A Value).

For more information about SECRET_HASH, see Computing secret hash values. For information about DEVICE_KEY, see Working with user devices in your user pool.

Returns:

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

addAuthParametersEntry

public InitiateAuthRequest addAuthParametersEntry(String key,
                                                  String value)

Add a single AuthParameters entry

See Also:

withAuthParameters(java.util.Map<java.lang.String, java.lang.String>)

clearAuthParametersEntries

public InitiateAuthRequest clearAuthParametersEntries()

Removes all the entries added into AuthParameters.

Returns:

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

getClientMetadata

public Map<String,String> getClientMetadata()

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

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

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:

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

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

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.

setClientMetadata

public void setClientMetadata(Map<String,String> clientMetadata)

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

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

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 certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

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.

withClientMetadata

public InitiateAuthRequest withClientMetadata(Map<String,String> clientMetadata)

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

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

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 certain custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

• Pre signup

• Pre authentication

• User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it doesn't provide the ClientMetadata value as input:

• Post authentication

• Custom message

• Pre token generation

• Create auth challenge

• Define auth challenge

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.

addClientMetadataEntry

public InitiateAuthRequest addClientMetadataEntry(String key,
                                                  String value)

Add a single ClientMetadata entry

See Also:

withClientMetadata(java.util.Map<java.lang.String, java.lang.String>)

clearClientMetadataEntries

public InitiateAuthRequest clearClientMetadataEntries()

Removes all the entries added into ClientMetadata.

Returns:

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

setClientId

public void setClientId(String clientId)

The app client ID.

Parameters:

clientId - The app client ID.

getClientId

public String getClientId()

The app client ID.

Returns:

The app client ID.

withClientId

public InitiateAuthRequest withClientId(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.

setAnalyticsMetadata

public void setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

Parameters:

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

getAnalyticsMetadata

public AnalyticsMetadataType getAnalyticsMetadata()

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

Returns:

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

withAnalyticsMetadata

public InitiateAuthRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

Parameters:

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

Returns:

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

setUserContextData

public void setUserContextData(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.

getUserContextData

public UserContextDataType getUserContextData()

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:

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.

withUserContextData

public InitiateAuthRequest withUserContextData(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public InitiateAuthRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()