java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.InitiateAuthRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<InitiateAuthRequest.Builder,InitiateAuthRequest>

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

Initiates the authentication request.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InitiateAuthRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AnalyticsMetadataType`	`analyticsMetadata()`	The Amazon Pinpoint analytics metadata that contributes to your metrics for `InitiateAuth` calls.
`AuthFlowType`	`authFlow()`	The authentication flow that you want to initiate.
`String`	`authFlowAsString()`	The authentication flow that you want to initiate.
`Map<String,String>`	`authParameters()`	The authentication parameters.
`static InitiateAuthRequest.Builder`	`builder()`
`String`	`clientId()`	The app client ID.
`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAuthParameters()`	For responses, this returns true if the service returned a value for the AuthParameters property.
`boolean`	`hasClientMetadata()`	For responses, this returns true if the service returned a value for the ClientMetadata property.
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InitiateAuthRequest.Builder>`	`serializableBuilderClass()`
`String`	`session()`	The optional session ID from a `ConfirmSignUp` API request.
`InitiateAuthRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UserContextDataType`	`userContextData()`	Contextual data about your user session, such as the device fingerprint, IP address, or location.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - authFlow
```
public final AuthFlowType authFlow()
```
    The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows and their parameters.
    
    USER_AUTH: Request a preferred authentication type or review available authentication types. From the offered authentication types, select one in a challenge response and then authenticate with that method in an additional challenge response.
    
    REFRESH_TOKEN_AUTH: Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value.
    
    USER_SRP_AUTH: Receive secure remote password (SRP) variables for the next challenge, PASSWORD_VERIFIER, when you pass USERNAME and SRP_A parameters.
    
    USER_PASSWORD_AUTH: Receive new tokens or the next challenge, for example SOFTWARE_TOKEN_MFA, when you pass USERNAME and PASSWORD parameters.
    
    All flows
    
    USER_AUTH
    
    The entry point for sign-in with passwords, one-time passwords, and WebAuthN authenticators.
    
    USER_SRP_AUTH
    
    Username-password authentication with the Secure Remote Password (SRP) protocol. For more information, see Use SRP password verification in custom authentication flow.
    
    REFRESH_TOKEN_AUTH and REFRESH_TOKEN
    
    Provide a valid refresh token and receive new ID and access tokens. For more information, see Using the refresh token.
    
    CUSTOM_AUTH
    
    Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.
    
    USER_PASSWORD_AUTH
    
    Username-password authentication with the password sent directly in the request. For more information, see Admin authentication flow.
    
    ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth. ADMIN_NO_SRP_AUTH is a legacy server-side username-password flow and isn't valid for InitiateAuth.
    
    If the service returns an enum value that is not available in the current SDK version, authFlow will return AuthFlowType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authFlowAsString().
    Returns:
    
    The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows and their parameters.
    
    USER_AUTH: Request a preferred authentication type or review available authentication types. From the offered authentication types, select one in a challenge response and then authenticate with that method in an additional challenge response.
    
    REFRESH_TOKEN_AUTH: Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value.
    
    USER_SRP_AUTH: Receive secure remote password (SRP) variables for the next challenge, PASSWORD_VERIFIER, when you pass USERNAME and SRP_A parameters.
    
    USER_PASSWORD_AUTH: Receive new tokens or the next challenge, for example SOFTWARE_TOKEN_MFA, when you pass USERNAME and PASSWORD parameters.
    
    All flows
    
    USER_AUTH
    
    The entry point for sign-in with passwords, one-time passwords, and WebAuthN authenticators.
    
    USER_SRP_AUTH
    
    Username-password authentication with the Secure Remote Password (SRP) protocol. For more information, see Use SRP password verification in custom authentication flow.
    
    REFRESH_TOKEN_AUTH and REFRESH_TOKEN
    
    Provide a valid refresh token and receive new ID and access tokens. For more information, see Using the refresh token.
    
    CUSTOM_AUTH
    
    Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.
    
    USER_PASSWORD_AUTH
    
    Username-password authentication with the password sent directly in the request. For more information, see Admin authentication flow.
    
    ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth. ADMIN_NO_SRP_AUTH is a legacy server-side username-password flow and isn't valid for InitiateAuth.
    
    See Also:
    
    AuthFlowType
  - authFlowAsString
```
public final String authFlowAsString()
```
    The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows and their parameters.
    
    USER_AUTH: Request a preferred authentication type or review available authentication types. From the offered authentication types, select one in a challenge response and then authenticate with that method in an additional challenge response.
    
    REFRESH_TOKEN_AUTH: Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value.
    
    USER_SRP_AUTH: Receive secure remote password (SRP) variables for the next challenge, PASSWORD_VERIFIER, when you pass USERNAME and SRP_A parameters.
    
    USER_PASSWORD_AUTH: Receive new tokens or the next challenge, for example SOFTWARE_TOKEN_MFA, when you pass USERNAME and PASSWORD parameters.
    
    All flows
    
    USER_AUTH
    
    The entry point for sign-in with passwords, one-time passwords, and WebAuthN authenticators.
    
    USER_SRP_AUTH
    
    Username-password authentication with the Secure Remote Password (SRP) protocol. For more information, see Use SRP password verification in custom authentication flow.
    
    REFRESH_TOKEN_AUTH and REFRESH_TOKEN
    
    Provide a valid refresh token and receive new ID and access tokens. For more information, see Using the refresh token.
    
    CUSTOM_AUTH
    
    Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.
    
    USER_PASSWORD_AUTH
    
    Username-password authentication with the password sent directly in the request. For more information, see Admin authentication flow.
    
    ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth. ADMIN_NO_SRP_AUTH is a legacy server-side username-password flow and isn't valid for InitiateAuth.
    
    If the service returns an enum value that is not available in the current SDK version, authFlow will return AuthFlowType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authFlowAsString().
    Returns:
    
    The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows and their parameters.
    
    USER_AUTH: Request a preferred authentication type or review available authentication types. From the offered authentication types, select one in a challenge response and then authenticate with that method in an additional challenge response.
    
    REFRESH_TOKEN_AUTH: Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value.
    
    USER_SRP_AUTH: Receive secure remote password (SRP) variables for the next challenge, PASSWORD_VERIFIER, when you pass USERNAME and SRP_A parameters.
    
    USER_PASSWORD_AUTH: Receive new tokens or the next challenge, for example SOFTWARE_TOKEN_MFA, when you pass USERNAME and PASSWORD parameters.
    
    All flows
    
    USER_AUTH
    
    The entry point for sign-in with passwords, one-time passwords, and WebAuthN authenticators.
    
    USER_SRP_AUTH
    
    Username-password authentication with the Secure Remote Password (SRP) protocol. For more information, see Use SRP password verification in custom authentication flow.
    
    REFRESH_TOKEN_AUTH and REFRESH_TOKEN
    
    Provide a valid refresh token and receive new ID and access tokens. For more information, see Using the refresh token.
    
    CUSTOM_AUTH
    
    Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.
    
    USER_PASSWORD_AUTH
    
    Username-password authentication with the password sent directly in the request. For more information, see Admin authentication flow.
    
    ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth. ADMIN_NO_SRP_AUTH is a legacy server-side username-password flow and isn't valid for InitiateAuth.
    
    See Also:
    
    AuthFlowType
  - hasAuthParameters
```
public final boolean hasAuthParameters()
```
    For responses, this returns true if the service returned a value for the AuthParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - authParameters
```
public final 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_AUTH: USERNAME (required), PREFERRED_CHALLENGE. If you don't provide a value for PREFERRED_CHALLENGE, Amazon Cognito responds with the AvailableChallenges parameter that specifies the available sign-in methods.
    
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthParameters() method.
    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_AUTH: USERNAME (required), PREFERRED_CHALLENGE. If you don't provide a value for PREFERRED_CHALLENGE, Amazon Cognito responds with the AvailableChallenges parameter that specifies the available sign-in methods.
    
    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.
  - hasClientMetadata
```
public final boolean hasClientMetadata()
```
    For responses, this returns true if the service returned a value for the ClientMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - clientMetadata
```
public final 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
    
    Custom email sender
    
    Custom SMS sender
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, note 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 send sensitive information in this parameter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientMetadata() method.
    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
    
    Custom email sender
    
    Custom SMS sender
    
    For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    When you use the ClientMetadata parameter, note 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 send sensitive information in this parameter.
  - clientId
```
public final String clientId()
```
    The app client ID.
    
    Returns:
    
    The app client ID.
  - analyticsMetadata
```
public final AnalyticsMetadataType analyticsMetadata()
```
    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.
  - userContextData
```
public final 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.
    
    For more information, see Collecting data for threat protection in applications.
    
    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.
    
    For more information, see Collecting data for threat protection in applications.
  - session
```
public final String session()
```
    The optional session ID from a ConfirmSignUp API request. You can sign in a user directly from the sign-up process with the USER_AUTH authentication flow.
    
    Returns:
    
    The optional session ID from a ConfirmSignUp API request. You can sign in a user directly from the sign-up process with the USER_AUTH authentication flow.
  - toBuilder
```
public InitiateAuthRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InitiateAuthRequest.Builder,InitiateAuthRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static InitiateAuthRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends InitiateAuthRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class InitiateAuthRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

authFlow

authFlowAsString

hasAuthParameters

authParameters

hasClientMetadata

clientMetadata

clientId

analyticsMetadata

userContextData

session

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField