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

Interface AdminRespondToAuthChallengeRequest.Builder

    • Method Detail

      • userPoolId

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

      • challengeResponses

        AdminRespondToAuthChallengeRequest.Builder challengeResponses​(Map<String,​String> challengeResponses)

        The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

        You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.

        SMS_MFA

        "ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}

        PASSWORD_VERIFIER

        "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

        Add "DEVICE_KEY" when you sign in with a remembered device.

        CUSTOM_CHALLENGE

        "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}

        Add "DEVICE_KEY" when you sign in with a remembered device.

        NEW_PASSWORD_REQUIRED

        "ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}

        To set any required attributes that InitiateAuth returned in an requiredAttributes parameter, add "userAttributes.[attribute_name]": "[attribute_value]". This parameter can also set values for writable attributes that aren't required by your user pool.

        In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

        SOFTWARE_TOKEN_MFA

        "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]}

        DEVICE_SRP_AUTH

        "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"}

        DEVICE_PASSWORD_VERIFIER

        "ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

        MFA_SETUP

        "ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"

        SELECT_MFA_TYPE

        "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"}

        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:
        challengeResponses - The responses to the challenge that you received in the previous request. Each challenge has its own required response parameters. The following examples are partial JSON request bodies that highlight challenge-response parameters.

        You must provide a SECRET_HASH parameter in all challenge responses to an app client that has a client secret.

        SMS_MFA

        "ChallengeName": "SMS_MFA", "ChallengeResponses": {"SMS_MFA_CODE": "[SMS_code]", "USERNAME": "[username]"}

        PASSWORD_VERIFIER

        "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses": {"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

        Add "DEVICE_KEY" when you sign in with a remembered device.

        CUSTOM_CHALLENGE

        "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[challenge_answer]"}

        Add "DEVICE_KEY" when you sign in with a remembered device.

        NEW_PASSWORD_REQUIRED

        "ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses": {"NEW_PASSWORD": "[new_password]", "USERNAME": "[username]"}

        To set any required attributes that InitiateAuth returned in an requiredAttributes parameter, add "userAttributes.[attribute_name]": "[attribute_value]". This parameter can also set values for writable attributes that aren't required by your user pool.

        In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter, then use the UpdateUserAttributes API operation to modify the value of any additional attributes.

        SOFTWARE_TOKEN_MFA

        "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses": {"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE": [authenticator_code]}

        DEVICE_SRP_AUTH

        "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": {"USERNAME": "[username]", "DEVICE_KEY": "[device_key]", "SRP_A": "[srp_a]"}

        DEVICE_PASSWORD_VERIFIER

        "ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses": {"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE": "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP": [timestamp], "USERNAME": "[username]"}

        MFA_SETUP

        "ChallengeName": "MFA_SETUP", "ChallengeResponses": {"USERNAME": "[username]"}, "SESSION": "[Session ID from VerifySoftwareToken]"

        SELECT_MFA_TYPE

        "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": {"USERNAME": "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"}

        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.

      • session

        AdminRespondToAuthChallengeRequest.Builder session​(String session)

        The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

        Parameters:
        session - The session that should be passed both ways in challenge-response calls to the service. If an InitiateAuth or RespondToAuthChallenge API call determines that the caller must pass another challenge, it returns a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • analyticsMetadata

        AdminRespondToAuthChallengeRequest.Builder analyticsMetadata​(AnalyticsMetadataType analyticsMetadata)

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

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

      • contextData

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

      • clientMetadata

        AdminRespondToAuthChallengeRequest.Builder clientMetadata​(Map<String,​String> clientMetadata)

        A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

        You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:

        • pre sign-up

        • custom message

        • post authentication

        • user migration

        • pre token generation

        • define auth challenge

        • create auth challenge

        • verify auth challenge response

        When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

        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 any custom workflows that this action triggers.

        You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:

        • pre sign-up

        • custom message

        • post authentication

        • user migration

        • pre token generation

        • define auth challenge

        • create auth challenge

        • verify auth challenge response

        When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

        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.