Network.AWS.CognitoIdentityProvider.RespondToAuthChallenge

Responds to the authentication challenge.

Creating a Request

respondToAuthChallenge

Arguments

:: Text

rtacClientId

-> ChallengeNameType

rtacChallengeName

-> RespondToAuthChallenge

Creates a value of RespondToAuthChallenge with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rtacAnalyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
• rtacChallengeResponses - The challenge responses. These are inputs corresponding to the value of ChallengeName , for example: * SMS_MFA : SMS_MFA_CODE , USERNAME , SECRET_HASH (if app client is configured with client secret). * PASSWORD_VERIFIER : PASSWORD_CLAIM_SIGNATURE , PASSWORD_CLAIM_SECRET_BLOCK , TIMESTAMP , USERNAME , SECRET_HASH (if app client is configured with client secret). * NEW_PASSWORD_REQUIRED : NEW_PASSWORD , any other required attributes, USERNAME , SECRET_HASH (if app client is configured with client secret).
• rtacUserContextData - Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
• rtacSession - The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
• rtacClientId - The app client ID.
• rtacChallengeName - The challenge name. For more information, see . ADMIN_NO_SRP_AUTH is not a valid value.

data RespondToAuthChallenge

The request to respond to an authentication challenge.

See: respondToAuthChallenge smart constructor.

Instances

Eq RespondToAuthChallenge

Methods

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

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

Data RespondToAuthChallenge

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RespondToAuthChallenge -> c RespondToAuthChallenge

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RespondToAuthChallenge

toConstr :: RespondToAuthChallenge -> Constr

dataTypeOf :: RespondToAuthChallenge -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RespondToAuthChallenge)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RespondToAuthChallenge)

gmapT :: (forall b. Data b => b -> b) -> RespondToAuthChallenge -> RespondToAuthChallenge

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RespondToAuthChallenge -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RespondToAuthChallenge -> r

gmapQ :: (forall d. Data d => d -> u) -> RespondToAuthChallenge -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RespondToAuthChallenge -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RespondToAuthChallenge -> m RespondToAuthChallenge

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondToAuthChallenge -> m RespondToAuthChallenge

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondToAuthChallenge -> m RespondToAuthChallenge

Show RespondToAuthChallenge

Methods

showsPrec :: Int -> RespondToAuthChallenge -> ShowS

show :: RespondToAuthChallenge -> String

showList :: [RespondToAuthChallenge] -> ShowS

Generic RespondToAuthChallenge

Associated Types

type Rep RespondToAuthChallenge :: * -> *

Methods

from :: RespondToAuthChallenge -> Rep RespondToAuthChallenge x

to :: Rep RespondToAuthChallenge x -> RespondToAuthChallenge

Hashable RespondToAuthChallenge

Methods

hashWithSalt :: Int -> RespondToAuthChallenge -> Int

hash :: RespondToAuthChallenge -> Int

ToJSON RespondToAuthChallenge

Methods

toJSON :: RespondToAuthChallenge -> Value

toEncoding :: RespondToAuthChallenge -> Encoding

toJSONList :: [RespondToAuthChallenge] -> Value

toEncodingList :: [RespondToAuthChallenge] -> Encoding

NFData RespondToAuthChallenge

Methods

rnf :: RespondToAuthChallenge -> ()

AWSRequest RespondToAuthChallenge

Associated Types

type Rs RespondToAuthChallenge :: *

Methods

request :: RespondToAuthChallenge -> Request RespondToAuthChallenge

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * RespondToAuthChallenge -> ClientResponse -> m (Response RespondToAuthChallenge)

ToHeaders RespondToAuthChallenge

Methods

toHeaders :: RespondToAuthChallenge -> [Header]

ToPath RespondToAuthChallenge

Methods

toPath :: RespondToAuthChallenge -> ByteString

ToQuery RespondToAuthChallenge

Methods

toQuery :: RespondToAuthChallenge -> QueryString

type Rep RespondToAuthChallenge

type Rep RespondToAuthChallenge = D1 * (MetaData "RespondToAuthChallenge" "Network.AWS.CognitoIdentityProvider.RespondToAuthChallenge" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "RespondToAuthChallenge'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rtacAnalyticsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AnalyticsMetadataType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtacChallengeResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_rtacUserContextData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe UserContextDataType))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtacSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtacClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))) (S1 * (MetaSel (Just Symbol "_rtacChallengeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ChallengeNameType))))))

type Rs RespondToAuthChallenge

type Rs RespondToAuthChallenge = RespondToAuthChallengeResponse

Request Lenses

rtacAnalyticsMetadata :: Lens' RespondToAuthChallenge (Maybe AnalyticsMetadataType)

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

rtacChallengeResponses :: Lens' RespondToAuthChallenge (HashMap Text Text)

The challenge responses. These are inputs corresponding to the value of ChallengeName , for example: * SMS_MFA : SMS_MFA_CODE , USERNAME , SECRET_HASH (if app client is configured with client secret). * PASSWORD_VERIFIER : PASSWORD_CLAIM_SIGNATURE , PASSWORD_CLAIM_SECRET_BLOCK , TIMESTAMP , USERNAME , SECRET_HASH (if app client is configured with client secret). * NEW_PASSWORD_REQUIRED : NEW_PASSWORD , any other required attributes, USERNAME , SECRET_HASH (if app client is configured with client secret).

rtacUserContextData :: Lens' RespondToAuthChallenge (Maybe UserContextDataType)

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

rtacSession :: Lens' RespondToAuthChallenge (Maybe Text)

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

rtacClientId :: Lens' RespondToAuthChallenge Text

The app client ID.

rtacChallengeName :: Lens' RespondToAuthChallenge ChallengeNameType

The challenge name. For more information, see . ADMIN_NO_SRP_AUTH is not a valid value.

Destructuring the Response

respondToAuthChallengeResponse

Arguments

:: Int

rtacrsResponseStatus

-> RespondToAuthChallengeResponse

Creates a value of RespondToAuthChallengeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rtacrsChallengeName - The challenge name. For more information, see .
• rtacrsChallengeParameters - The challenge parameters. For more information, see .
• rtacrsAuthenticationResult - The result returned by the server in response to the request to respond to the authentication challenge.
• rtacrsSession - The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
• rtacrsResponseStatus - -- | The response status code.

data RespondToAuthChallengeResponse

The response to respond to the authentication challenge.

See: respondToAuthChallengeResponse smart constructor.

Instances

Eq RespondToAuthChallengeResponse

Methods

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

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

Data RespondToAuthChallengeResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RespondToAuthChallengeResponse -> c RespondToAuthChallengeResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RespondToAuthChallengeResponse

toConstr :: RespondToAuthChallengeResponse -> Constr

dataTypeOf :: RespondToAuthChallengeResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RespondToAuthChallengeResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RespondToAuthChallengeResponse)

gmapT :: (forall b. Data b => b -> b) -> RespondToAuthChallengeResponse -> RespondToAuthChallengeResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RespondToAuthChallengeResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RespondToAuthChallengeResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RespondToAuthChallengeResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RespondToAuthChallengeResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RespondToAuthChallengeResponse -> m RespondToAuthChallengeResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondToAuthChallengeResponse -> m RespondToAuthChallengeResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RespondToAuthChallengeResponse -> m RespondToAuthChallengeResponse

Show RespondToAuthChallengeResponse

Methods

showsPrec :: Int -> RespondToAuthChallengeResponse -> ShowS

show :: RespondToAuthChallengeResponse -> String

showList :: [RespondToAuthChallengeResponse] -> ShowS

Generic RespondToAuthChallengeResponse

Associated Types

type Rep RespondToAuthChallengeResponse :: * -> *

Methods

from :: RespondToAuthChallengeResponse -> Rep RespondToAuthChallengeResponse x

to :: Rep RespondToAuthChallengeResponse x -> RespondToAuthChallengeResponse

NFData RespondToAuthChallengeResponse

Methods

rnf :: RespondToAuthChallengeResponse -> ()

type Rep RespondToAuthChallengeResponse

type Rep RespondToAuthChallengeResponse = D1 * (MetaData "RespondToAuthChallengeResponse" "Network.AWS.CognitoIdentityProvider.RespondToAuthChallenge" "amazonka-cognito-idp-1.6.0-JhJp6CX0k821Z1WSNBuBfd" False) (C1 * (MetaCons "RespondToAuthChallengeResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rtacrsChallengeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ChallengeNameType))) (S1 * (MetaSel (Just Symbol "_rtacrsChallengeParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtacrsAuthenticationResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe AuthenticationResultType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rtacrsSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rtacrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

rtacrsChallengeName :: Lens' RespondToAuthChallengeResponse (Maybe ChallengeNameType)

The challenge name. For more information, see .

rtacrsChallengeParameters :: Lens' RespondToAuthChallengeResponse (HashMap Text Text)

The challenge parameters. For more information, see .

rtacrsAuthenticationResult :: Lens' RespondToAuthChallengeResponse (Maybe AuthenticationResultType)

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

rtacrsSession :: Lens' RespondToAuthChallengeResponse (Maybe Text)

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

rtacrsResponseStatus :: Lens' RespondToAuthChallengeResponse Int

• - | The response status code.