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

Interface InitiateAuthRequest.Builder

    • Method Detail

      • authFlow

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

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

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

      • authFlow

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

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

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

      • authParameters

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

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

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

      • clientMetadata

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

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

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

      • clientId

        InitiateAuthRequest.Builder clientId​(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.

      • analyticsMetadata

        InitiateAuthRequest.Builder analyticsMetadata​(AnalyticsMetadataType analyticsMetadata)

        The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.

        Parameters:
        analyticsMetadata - The Amazon Pinpoint analytics metadata that contributes to your metrics for InitiateAuth calls.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userContextData

        InitiateAuthRequest.Builder userContextData​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • session

        InitiateAuthRequest.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 the USER_AUTH authentication flow.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.