AdminInitiateAuthRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.13.47 API)

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

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

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

Initiates the authorization request, as an administrator.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AdminInitiateAuthRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AdminInitiateAuthRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyticsMetadataType`	`analyticsMetadata()` The analytics metadata for collecting Amazon Pinpoint metrics for `AdminInitiateAuth` calls.
`AuthFlowType`	`authFlow()` The authentication flow for this call to execute.
`String`	`authFlowAsString()` The authentication flow for this call to execute.
`Map<String,String>`	`authParameters()` The authentication parameters.
`static AdminInitiateAuthRequest.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.
`ContextDataType`	`contextData()` 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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAuthParameters()` Returns true if the AuthParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasClientMetadata()` Returns true if the ClientMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AdminInitiateAuthRequest.Builder>`	`serializableBuilderClass()`
`AdminInitiateAuthRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userPoolId()` The ID of the Amazon Cognito user pool.

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
  - userPoolId
```
public String userPoolId()
```
    The ID of the Amazon Cognito user pool.
    
    Returns:
    
    The ID of the Amazon Cognito user pool.
  - clientId
```
public String clientId()
```
    The app client ID.
    
    Returns:
    
    The app client ID.
  - authFlow
```
public 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.
    - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    - 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_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
    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 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.
    
    ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    
    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_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
    See Also:
    
    AuthFlowType
  - authFlowAsString
```
public String authFlowAsString()
```
    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.
    - ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    - 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_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
    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 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.
    
    ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.
    
    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_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
    See Also:
    
    AuthFlowType
  - hasAuthParameters
```
public boolean hasAuthParameters()
```
    Returns true if the AuthParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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), 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 ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    - For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAuthParameters() to see if a value was sent in this field.
    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 ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY
    
    For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
  - hasClientMetadata
```
public boolean hasClientMetadata()
```
    Returns true if the ClientMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - clientMetadata
```
public 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 AWS Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS 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 AdminInitiateAuth request. In your function code in AWS Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:
    - Post authentication
    - Custom message
    - Pre token generation
    - Create auth challenge
    - Define auth challenge
    - Verify auth challenge
    For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    Take the following limitations into consideration when you use the ClientMetadata parameter:
    
    Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
    
    Amazon Cognito does not validate the ClientMetadata value.
    
    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasClientMetadata() to see if a value was sent in this field.
    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 AWS Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS 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 AdminInitiateAuth request. In your function code in AWS Lambda, you can process the validationData value to enhance your workflow for your specific needs.
    
    When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:
    
    Post authentication
    
    Custom message
    
    Pre token generation
    
    Create auth challenge
    
    Define auth challenge
    
    Verify auth challenge
    
    For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
    
    Take the following limitations into consideration when you use the ClientMetadata parameter:
    
    Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
    
    Amazon Cognito does not validate the ClientMetadata value.
    
    Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
  - analyticsMetadata
```
public AnalyticsMetadataType analyticsMetadata()
```
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
    
    Returns:
    
    The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
  - contextData
```
public ContextDataType contextData()
```
    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.
  - toBuilder
```
public AdminInitiateAuthRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static AdminInitiateAuthRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AdminInitiateAuthRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AdminInitiateAuthRequest

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

userPoolId

clientId

authFlow

authFlowAsString

hasAuthParameters

authParameters

hasClientMetadata

clientMetadata

analyticsMetadata

contextData

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields