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)
InitiateAuthRequest	addClientMetadataEntry(String key, String value)
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 for collecting metrics for InitiateAuth calls.
String	getAuthFlow() The authentication flow for this call to execute.
Map<String,String>	getAuthParameters() The authentication parameters.
String	getClientId() The app client ID.
Map<String,String>	getClientMetadata() This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is.
UserContextDataType	getUserContextData() 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.
int	hashCode()
void	setAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.
void	setAuthFlow(AuthFlowType authFlow) The authentication flow for this call to execute.
void	setAuthFlow(String authFlow) The authentication flow for this call to execute.
void	setAuthParameters(Map<String,String> authParameters) The authentication parameters.
void	setClientId(String clientId) The app client ID.
void	setClientMetadata(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.
void	setUserContextData(UserContextDataType userContextData) 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.
String	toString() Returns a string representation of this object.
InitiateAuthRequest	withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.
InitiateAuthRequest	withAuthFlow(AuthFlowType authFlow) The authentication flow for this call to execute.
InitiateAuthRequest	withAuthFlow(String authFlow) The authentication flow for this call to execute.
InitiateAuthRequest	withAuthParameters(Map<String,String> authParameters) The authentication parameters.
InitiateAuthRequest	withClientId(String clientId) The app client ID.
InitiateAuthRequest	withClientMetadata(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.
InitiateAuthRequest	withUserContextData(UserContextDataType userContextData) 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.

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

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

ADMIN_NO_SRP_AUTH is not a valid value.

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.

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

ADMIN_NO_SRP_AUTH is not a valid value.

See Also:

AuthFlowType

getAuthFlow

public String getAuthFlow()

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.

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

ADMIN_NO_SRP_AUTH is not a valid value.

Returns:

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.

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

ADMIN_NO_SRP_AUTH is not a valid value.

See Also:

AuthFlowType

withAuthFlow

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

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

ADMIN_NO_SRP_AUTH is not a valid value.

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.

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

ADMIN_NO_SRP_AUTH is not 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 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.

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

ADMIN_NO_SRP_AUTH is not a valid value.

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.

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

ADMIN_NO_SRP_AUTH is not a valid value.

See Also:

AuthFlowType

withAuthFlow

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

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

ADMIN_NO_SRP_AUTH is not a valid value.

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.

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

ADMIN_NO_SRP_AUTH is not 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 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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

Returns:

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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

setAuthParameters

public void setAuthParameters(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 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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

withAuthParameters

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

addAuthParametersEntry

public InitiateAuthRequest addAuthParametersEntry(String key,
                                                  String value)

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()

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:

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.

setClientMetadata

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

withClientMetadata

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

addClientMetadataEntry

public InitiateAuthRequest addClientMetadataEntry(String key,
                                                  String value)

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 for collecting metrics for InitiateAuth calls.

Parameters:

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

getAnalyticsMetadata

public AnalyticsMetadataType getAnalyticsMetadata()

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

Returns:

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

withAnalyticsMetadata

public InitiateAuthRequest withAnalyticsMetadata(AnalyticsMetadataType analyticsMetadata)

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

Parameters:

analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting 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 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:

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

getUserContextData

public UserContextDataType getUserContextData()

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:

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.

withUserContextData

public InitiateAuthRequest withUserContextData(UserContextDataType userContextData)

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:

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

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()