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

Class InitiateAuthRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.InitiateAuthRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<InitiateAuthRequest.Builder,InitiateAuthRequest>

@Generated("software.amazon.awssdk:codegen")
public class InitiateAuthRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<InitiateAuthRequest.Builder,InitiateAuthRequest>

Initiates the authentication request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InitiateAuthRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	authFlow()	The authentication flow for this call to execute.
Map<String,String>	authParameters()	The authentication parameters.
static InitiateAuthRequest.Builder	builder()
String	clientId()	The app client ID.
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.
boolean	equals(Object obj)
int	hashCode()
static Class<? extends InitiateAuthRequest.Builder>	serializableBuilderClass()
InitiateAuthRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

authFlow

public 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 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 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 is not a valid value.

See Also:

AuthFlowType

authParameters

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

clientMetadata

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

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.

clientId

public String clientId()

The app client ID.

Returns:

The app client ID.

toBuilder

public InitiateAuthRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<InitiateAuthRequest.Builder,InitiateAuthRequest>

Returns:

a builder for type T

builder

public static InitiateAuthRequest.Builder builder()

serializableBuilderClass

public static Class<? extends InitiateAuthRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object