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

Interface AdminInitiateAuthRequest.Builder

    • Method Detail

      • userPoolId

        AdminInitiateAuthRequest.Builder userPoolId​(String userPoolId)

        The ID of the Amazon Cognito user pool.

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

      • clientId

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

      • authFlow

        AdminInitiateAuthRequest.Builder authFlow​(String authFlow)

        The authentication flow for this call to run. 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 Secure Remote Password (SRP) protocol variables to be used for next challenge execution.

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

        • ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.

        Parameters:
        authFlow - The authentication flow for this call to run. 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 Secure Remote Password (SRP) protocol variables to be used for next challenge execution.

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

        • ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.

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

      • authFlow

        AdminInitiateAuthRequest.Builder authFlow​(AuthFlowType authFlow)

        The authentication flow for this call to run. 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 Secure Remote Password (SRP) protocol variables to be used for next challenge execution.

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

        • ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.

        Parameters:
        authFlow - The authentication flow for this call to run. 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 Secure Remote Password (SRP) protocol variables to be used for next challenge execution.

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

        • ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Amazon Cognito receives the password in the request instead of using the SRP process to verify passwords.

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

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

        For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

        When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.

        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

        For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

        When you use the ClientMetadata parameter, remember 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 use Amazon Cognito to provide sensitive information.

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

      • analyticsMetadata

        AdminInitiateAuthRequest.Builder analyticsMetadata​(AnalyticsMetadataType analyticsMetadata)

        The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

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

      • contextData

        AdminInitiateAuthRequest.Builder contextData​(ContextDataType contextData)

        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.

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