Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Responds to the authentication challenge.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <https:docs.aws.amazon.comsnslatestdgsns-sms-sandbox.html sandbox mode> , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Creating a Request

data RespondToAuthChallenge

The request to respond to an authentication challenge.

See: newRespondToAuthChallenge smart constructor.

Constructors

RespondToAuthChallenge'

Fields

• analyticsMetadata :: Maybe AnalyticsMetadataType

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

• challengeResponses :: Maybe (HashMap Text Text)

  The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

  SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

    PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. 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: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
  • MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.
• clientMetadata :: Maybe (HashMap Text Text)

  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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, /define auth challenge, create auth challenge, and verify auth challenge/. 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, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge 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.
• session :: Maybe Text

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

• userContextData :: Maybe UserContextDataType

  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.

• clientId :: Sensitive Text

  The app client ID.

• challengeName :: ChallengeNameType

  The challenge name. For more information, see InitiateAuth.

  ADMIN_NO_SRP_AUTH isn't a valid value.

Instances

ToJSON RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

toJSON :: RespondToAuthChallenge -> Value

toEncoding :: RespondToAuthChallenge -> Encoding

toJSONList :: [RespondToAuthChallenge] -> Value

toEncodingList :: [RespondToAuthChallenge] -> Encoding

ToHeaders RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

toHeaders :: RespondToAuthChallenge -> [Header]

ToPath RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

toPath :: RespondToAuthChallenge -> ByteString

ToQuery RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

toQuery :: RespondToAuthChallenge -> QueryString

AWSRequest RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Associated Types

type AWSResponse RespondToAuthChallenge

Methods

request :: (Service -> Service) -> RespondToAuthChallenge -> Request RespondToAuthChallenge

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RespondToAuthChallenge -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RespondToAuthChallenge)))

Generic RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Associated Types

type Rep RespondToAuthChallenge :: Type -> Type

Methods

from :: RespondToAuthChallenge -> Rep RespondToAuthChallenge x

to :: Rep RespondToAuthChallenge x -> RespondToAuthChallenge

Show RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

showsPrec :: Int -> RespondToAuthChallenge -> ShowS

show :: RespondToAuthChallenge -> String

showList :: [RespondToAuthChallenge] -> ShowS

NFData RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

rnf :: RespondToAuthChallenge -> ()

Eq RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

(==) :: RespondToAuthChallenge -> RespondToAuthChallenge -> Bool

(/=) :: RespondToAuthChallenge -> RespondToAuthChallenge -> Bool

Hashable RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

hashWithSalt :: Int -> RespondToAuthChallenge -> Int

hash :: RespondToAuthChallenge -> Int

type AWSResponse RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

type AWSResponse RespondToAuthChallenge = RespondToAuthChallengeResponse

type Rep RespondToAuthChallenge

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

type Rep RespondToAuthChallenge = D1 ('MetaData "RespondToAuthChallenge" "Amazonka.CognitoIdentityProvider.RespondToAuthChallenge" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "RespondToAuthChallenge'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "analyticsMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AnalyticsMetadataType)) :*: (S1 ('MetaSel ('Just "challengeResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "clientMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userContextData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContextDataType))) :*: (S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "challengeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChallengeNameType)))))

newRespondToAuthChallenge

Arguments

:: Text

RespondToAuthChallenge

-> ChallengeNameType

RespondToAuthChallenge

-> RespondToAuthChallenge

Create a value of RespondToAuthChallenge with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:analyticsMetadata:RespondToAuthChallenge', respondToAuthChallenge_analyticsMetadata - The Amazon Pinpoint analytics metadata that contributes to your metrics for RespondToAuthChallenge calls.

RespondToAuthChallenge, respondToAuthChallenge_challengeResponses - The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

• SMS_MFA: SMS_MFA_CODE, USERNAME.

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. 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: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
• DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
• DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
• MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

$sel:clientMetadata:RespondToAuthChallenge', respondToAuthChallenge_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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, /define auth challenge, create auth challenge, and verify auth challenge/. 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, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge 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.

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

$sel:userContextData:RespondToAuthChallenge', respondToAuthChallenge_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.

RespondToAuthChallenge, respondToAuthChallenge_clientId - The app client ID.

RespondToAuthChallenge, respondToAuthChallenge_challengeName - The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

Request Lenses

respondToAuthChallenge_analyticsMetadata :: Lens' RespondToAuthChallenge (Maybe AnalyticsMetadataType)

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

respondToAuthChallenge_challengeResponses :: Lens' RespondToAuthChallenge (Maybe (HashMap Text Text))

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all of the inputs that follow (including SOFTWARE_TOKEN_MFA).

• SMS_MFA: SMS_MFA_CODE, USERNAME.

• PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  PASSWORD_VERIFIER requires DEVICE_KEY when you sign in with a remembered device.

• NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). To set any required attributes that Amazon Cognito returned as requiredAttributes in the InitiateAuth response, add a userAttributes.attributename parameter. 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: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.
• DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).
• DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires, plus DEVICE_KEY.
• MFA_SETUP requires USERNAME, plus you must use the session value returned by VerifySoftwareToken in the Session parameter.

respondToAuthChallenge_clientMetadata :: Lens' RespondToAuthChallenge (Maybe (HashMap Text Text))

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 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, /define auth challenge, create auth challenge, and verify auth challenge/. 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, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge 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.

respondToAuthChallenge_session :: Lens' RespondToAuthChallenge (Maybe Text)

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

respondToAuthChallenge_userContextData :: Lens' RespondToAuthChallenge (Maybe UserContextDataType)

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.

respondToAuthChallenge_clientId :: Lens' RespondToAuthChallenge Text

The app client ID.

respondToAuthChallenge_challengeName :: Lens' RespondToAuthChallenge ChallengeNameType

The challenge name. For more information, see InitiateAuth.

ADMIN_NO_SRP_AUTH isn't a valid value.

Destructuring the Response

data RespondToAuthChallengeResponse

The response to respond to the authentication challenge.

See: newRespondToAuthChallengeResponse smart constructor.

Constructors

RespondToAuthChallengeResponse'

Fields

• authenticationResult :: Maybe AuthenticationResultType

  The result returned by the server in response to the request to respond to the authentication challenge.

• challengeName :: Maybe ChallengeNameType

  The challenge name. For more information, see InitiateAuth.

• challengeParameters :: Maybe (HashMap Text Text)

  The challenge parameters. For more information, see InitiateAuth.

• session :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic RespondToAuthChallengeResponse

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Associated Types

type Rep RespondToAuthChallengeResponse :: Type -> Type

Methods

from :: RespondToAuthChallengeResponse -> Rep RespondToAuthChallengeResponse x

to :: Rep RespondToAuthChallengeResponse x -> RespondToAuthChallengeResponse

Show RespondToAuthChallengeResponse

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

showsPrec :: Int -> RespondToAuthChallengeResponse -> ShowS

show :: RespondToAuthChallengeResponse -> String

showList :: [RespondToAuthChallengeResponse] -> ShowS

NFData RespondToAuthChallengeResponse

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

rnf :: RespondToAuthChallengeResponse -> ()

Eq RespondToAuthChallengeResponse

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

Methods

(==) :: RespondToAuthChallengeResponse -> RespondToAuthChallengeResponse -> Bool

(/=) :: RespondToAuthChallengeResponse -> RespondToAuthChallengeResponse -> Bool

type Rep RespondToAuthChallengeResponse

Defined in Amazonka.CognitoIdentityProvider.RespondToAuthChallenge

type Rep RespondToAuthChallengeResponse = D1 ('MetaData "RespondToAuthChallengeResponse" "Amazonka.CognitoIdentityProvider.RespondToAuthChallenge" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "RespondToAuthChallengeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationResultType)) :*: S1 ('MetaSel ('Just "challengeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChallengeNameType))) :*: (S1 ('MetaSel ('Just "challengeParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newRespondToAuthChallengeResponse

Arguments

:: Int

$sel:httpStatus:RespondToAuthChallengeResponse'

-> RespondToAuthChallengeResponse

Create a value of RespondToAuthChallengeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationResult:RespondToAuthChallengeResponse', respondToAuthChallengeResponse_authenticationResult - The result returned by the server in response to the request to respond to the authentication challenge.

RespondToAuthChallenge, respondToAuthChallengeResponse_challengeName - The challenge name. For more information, see InitiateAuth.

$sel:challengeParameters:RespondToAuthChallengeResponse', respondToAuthChallengeResponse_challengeParameters - The challenge parameters. For more information, see InitiateAuth.

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

$sel:httpStatus:RespondToAuthChallengeResponse', respondToAuthChallengeResponse_httpStatus - The response's http status code.

Response Lenses

respondToAuthChallengeResponse_authenticationResult :: Lens' RespondToAuthChallengeResponse (Maybe AuthenticationResultType)

The result returned by the server in response to the request to respond to the authentication challenge.

respondToAuthChallengeResponse_challengeName :: Lens' RespondToAuthChallengeResponse (Maybe ChallengeNameType)

The challenge name. For more information, see InitiateAuth.

respondToAuthChallengeResponse_challengeParameters :: Lens' RespondToAuthChallengeResponse (Maybe (HashMap Text Text))

The challenge parameters. For more information, see InitiateAuth.

respondToAuthChallengeResponse_session :: Lens' RespondToAuthChallengeResponse (Maybe Text)

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

respondToAuthChallengeResponse_httpStatus :: Lens' RespondToAuthChallengeResponse Int

The response's http status code.