Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Responds to the authentication challenge.
- respondToAuthChallenge :: Text -> ChallengeNameType -> RespondToAuthChallenge
- data RespondToAuthChallenge
- rtacChallengeResponses :: Lens' RespondToAuthChallenge (HashMap Text Text)
- rtacSession :: Lens' RespondToAuthChallenge (Maybe Text)
- rtacClientId :: Lens' RespondToAuthChallenge Text
- rtacChallengeName :: Lens' RespondToAuthChallenge ChallengeNameType
- respondToAuthChallengeResponse :: Int -> RespondToAuthChallengeResponse
- data RespondToAuthChallengeResponse
- rtacrsChallengeName :: Lens' RespondToAuthChallengeResponse (Maybe ChallengeNameType)
- rtacrsChallengeParameters :: Lens' RespondToAuthChallengeResponse (HashMap Text Text)
- rtacrsAuthenticationResult :: Lens' RespondToAuthChallengeResponse (Maybe AuthenticationResultType)
- rtacrsSession :: Lens' RespondToAuthChallengeResponse (Maybe Text)
- rtacrsResponseStatus :: Lens' RespondToAuthChallengeResponse Int
Creating a Request
respondToAuthChallenge Source #
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:
rtacChallengeResponses
- The challenge responses. These are inputs corresponding to the value ofChallengeName
, 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).rtacSession
- The session which should be passed both ways in challenge-response calls to the service. IfInitiateAuth
orRespondToAuthChallenge
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 nextRespondToAuthChallenge
API call.rtacClientId
- The app client ID.rtacChallengeName
- The challenge name. For more information, see InitiateAuth .ADMIN_NO_SRP_AUTH
is not a valid value.
data RespondToAuthChallenge Source #
The request to respond to an authentication challenge.
See: respondToAuthChallenge
smart constructor.
Request Lenses
rtacChallengeResponses :: Lens' RespondToAuthChallenge (HashMap Text Text) Source #
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).
rtacSession :: Lens' RespondToAuthChallenge (Maybe Text) Source #
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 Source #
The app client ID.
rtacChallengeName :: Lens' RespondToAuthChallenge ChallengeNameType Source #
The challenge name. For more information, see InitiateAuth . ADMIN_NO_SRP_AUTH
is not a valid value.
Destructuring the Response
respondToAuthChallengeResponse Source #
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 InitiateAuth .rtacrsChallengeParameters
- The challenge parameters. For more information, see InitiateAuth .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 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 nextRespondToAuthChallenge
API call.rtacrsResponseStatus
- -- | The response status code.
data RespondToAuthChallengeResponse Source #
The response to respond to the authentication challenge.
See: respondToAuthChallengeResponse
smart constructor.
Response Lenses
rtacrsChallengeName :: Lens' RespondToAuthChallengeResponse (Maybe ChallengeNameType) Source #
The challenge name. For more information, see InitiateAuth .
rtacrsChallengeParameters :: Lens' RespondToAuthChallengeResponse (HashMap Text Text) Source #
The challenge parameters. For more information, see InitiateAuth .
rtacrsAuthenticationResult :: Lens' RespondToAuthChallengeResponse (Maybe AuthenticationResultType) Source #
The result returned by the server in response to the request to respond to the authentication challenge.
rtacrsSession :: Lens' RespondToAuthChallengeResponse (Maybe Text) Source #
The session which should be passed both ways in challenge-response calls to the service. If the 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.
rtacrsResponseStatus :: Lens' RespondToAuthChallengeResponse Int Source #
- - | The response status code.