Interface AdminInitiateAuthRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>, SdkBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
AdminInitiateAuthRequest
@Mutable @NotThreadSafe public static interface AdminInitiateAuthRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<AdminInitiateAuthRequest.Builder,AdminInitiateAuthRequest>

  • Method Details

    • userPoolId

      AdminInitiateAuthRequest.Builder userPoolId(String userPoolId)

      The ID of the user pool where the user wants to sign in.

      Parameters:
      userPoolId - The ID of the user pool where the user wants to sign in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientId

      AdminInitiateAuthRequest.Builder clientId(String clientId)

      The ID of the app client where the user wants to sign in.

      Parameters:
      clientId - The ID of the app client where the user wants to sign in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authFlow

      AdminInitiateAuthRequest.Builder authFlow(String authFlow)

      The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows.

      USER_AUTH

      The entry point for choice-based authentication with passwords, one-time passwords, and WebAuthn authenticators. 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. To activate this setting, your user pool must be in the Essentials tier or higher.

      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

      Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value. For more information, see Using the refresh token.

      CUSTOM_AUTH

      Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.

      ADMIN_USER_PASSWORD_AUTH

      Server-side username-password authentication with the password sent directly in the request. For more information about client-side and server-side authentication, see SDK authorization models.

      Parameters:
      authFlow - The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows.

      USER_AUTH

      The entry point for choice-based authentication with passwords, one-time passwords, and WebAuthn authenticators. 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. To activate this setting, your user pool must be in the Essentials tier or higher.

      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

      Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value. For more information, see Using the refresh token.

      CUSTOM_AUTH

      Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.

      ADMIN_USER_PASSWORD_AUTH

      Server-side username-password authentication with the password sent directly in the request. For more information about client-side and server-side authentication, see SDK authorization models.

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

    • authFlow

      AdminInitiateAuthRequest.Builder authFlow(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.

      USER_AUTH

      The entry point for choice-based authentication with passwords, one-time passwords, and WebAuthn authenticators. 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. To activate this setting, your user pool must be in the Essentials tier or higher.

      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

      Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value. For more information, see Using the refresh token.

      CUSTOM_AUTH

      Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.

      ADMIN_USER_PASSWORD_AUTH

      Server-side username-password authentication with the password sent directly in the request. For more information about client-side and server-side authentication, see SDK authorization models.

      Parameters:
      authFlow - The authentication flow that you want to initiate. Each AuthFlow has linked AuthParameters that you must submit. The following are some example flows.

      USER_AUTH

      The entry point for choice-based authentication with passwords, one-time passwords, and WebAuthn authenticators. 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. To activate this setting, your user pool must be in the Essentials tier or higher.

      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

      Receive new ID and access tokens when you pass a REFRESH_TOKEN parameter with a valid refresh token as the value. For more information, see Using the refresh token.

      CUSTOM_AUTH

      Custom authentication with Lambda triggers. For more information, see Custom authentication challenge Lambda triggers.

      ADMIN_USER_PASSWORD_AUTH

      Server-side username-password authentication with the password sent directly in the request. For more information about client-side and server-side authentication, see SDK authorization models.

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

    • authParameters

      AdminInitiateAuthRequest.Builder authParameters(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 example:

      • 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 ADMIN_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 example:

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

    • clientMetadata

      AdminInitiateAuthRequest.Builder clientMetadata(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 AdminInitiateAuth 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 AdminInitiateAuth 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 AdminInitiateAuth 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 Using 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.

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

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

    • analyticsMetadata

      AdminInitiateAuthRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

      Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

      Parameters:
      analyticsMetadata - Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analyticsMetadata

      default AdminInitiateAuthRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)

      Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

      This is a convenience method that creates an instance of the AnalyticsMetadataType.Builder avoiding the need to create one manually via AnalyticsMetadataType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analyticsMetadata(AnalyticsMetadataType).

      Parameters:
      analyticsMetadata - a consumer that will call methods on AnalyticsMetadataType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contextData

      AdminInitiateAuthRequest.Builder contextData(ContextDataType contextData)

      Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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.

      Parameters:
      contextData - Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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:
      Returns a reference to this object so that method calls can be chained together.

    • contextData

      default AdminInitiateAuthRequest.Builder contextData(Consumer<ContextDataType.Builder> contextData)

      Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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.

      This is a convenience method that creates an instance of the ContextDataType.Builder avoiding the need to create one manually via ContextDataType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contextData(ContextDataType).

      Parameters:
      contextData - a consumer that will call methods on ContextDataType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • session

      AdminInitiateAuthRequest.Builder session(String session)

      The optional session ID from a ConfirmSignUp API request. You can sign in a user directly from the sign-up process with an AuthFlow of USER_AUTH and AuthParameters of EMAIL_OTP or SMS_OTP, depending on how your user pool sent the confirmation-code message.

      Parameters:
      session - The optional session ID from a ConfirmSignUp API request. You can sign in a user directly from the sign-up process with an AuthFlow of USER_AUTH and AuthParameters of EMAIL_OTP or SMS_OTP, depending on how your user pool sent the confirmation-code message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      AdminInitiateAuthRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      AdminInitiateAuthRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.