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 an authentication challenge, as an administrator.
Requires developer credentials.
- adminRespondToAuthChallenge :: Text -> Text -> ChallengeNameType -> AdminRespondToAuthChallenge
- data AdminRespondToAuthChallenge
- artacChallengeResponses :: Lens' AdminRespondToAuthChallenge (HashMap Text Text)
- artacSession :: Lens' AdminRespondToAuthChallenge (Maybe Text)
- artacUserPoolId :: Lens' AdminRespondToAuthChallenge Text
- artacClientId :: Lens' AdminRespondToAuthChallenge Text
- artacChallengeName :: Lens' AdminRespondToAuthChallenge ChallengeNameType
- adminRespondToAuthChallengeResponse :: Int -> AdminRespondToAuthChallengeResponse
- data AdminRespondToAuthChallengeResponse
- artacrsChallengeName :: Lens' AdminRespondToAuthChallengeResponse (Maybe ChallengeNameType)
- artacrsChallengeParameters :: Lens' AdminRespondToAuthChallengeResponse (HashMap Text Text)
- artacrsAuthenticationResult :: Lens' AdminRespondToAuthChallengeResponse (Maybe AuthenticationResultType)
- artacrsSession :: Lens' AdminRespondToAuthChallengeResponse (Maybe Text)
- artacrsResponseStatus :: Lens' AdminRespondToAuthChallengeResponse Int
Creating a Request
adminRespondToAuthChallenge Source #
Creates a value of AdminRespondToAuthChallenge
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
artacChallengeResponses
- 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). *ADMIN_NO_SRP_AUTH
:PASSWORD
,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). The value of theUSERNAME
attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, theAdminInitiateAuth
response includes the actual username value in theUSERNAMEUSER_ID_FOR_SRP
attribute, even if you specified an alias in your call toAdminInitiateAuth
.artacSession
- 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.artacUserPoolId
- The ID of the Amazon Cognito user pool.artacClientId
- The app client ID.artacChallengeName
- The challenge name. For more information, see AdminInitiateAuth .
data AdminRespondToAuthChallenge Source #
The request to respond to the authentication challenge, as an administrator.
See: adminRespondToAuthChallenge
smart constructor.
Request Lenses
artacChallengeResponses :: Lens' AdminRespondToAuthChallenge (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). * ADMIN_NO_SRP_AUTH
: PASSWORD
, 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). The value of the USERNAME
attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth
response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP
attribute, even if you specified an alias in your call to AdminInitiateAuth
.
artacSession :: Lens' AdminRespondToAuthChallenge (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.
artacUserPoolId :: Lens' AdminRespondToAuthChallenge Text Source #
The ID of the Amazon Cognito user pool.
artacClientId :: Lens' AdminRespondToAuthChallenge Text Source #
The app client ID.
artacChallengeName :: Lens' AdminRespondToAuthChallenge ChallengeNameType Source #
The challenge name. For more information, see AdminInitiateAuth .
Destructuring the Response
adminRespondToAuthChallengeResponse Source #
Creates a value of AdminRespondToAuthChallengeResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
artacrsChallengeName
- The name of the challenge. For more information, see AdminInitiateAuth .artacrsChallengeParameters
- The challenge parameters. For more information, see AdminInitiateAuth .artacrsAuthenticationResult
- The result returned by the server in response to the authentication request.artacrsSession
- 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.artacrsResponseStatus
- -- | The response status code.
data AdminRespondToAuthChallengeResponse Source #
Responds to the authentication challenge, as an administrator.
See: adminRespondToAuthChallengeResponse
smart constructor.
Response Lenses
artacrsChallengeName :: Lens' AdminRespondToAuthChallengeResponse (Maybe ChallengeNameType) Source #
The name of the challenge. For more information, see AdminInitiateAuth .
artacrsChallengeParameters :: Lens' AdminRespondToAuthChallengeResponse (HashMap Text Text) Source #
The challenge parameters. For more information, see AdminInitiateAuth .
artacrsAuthenticationResult :: Lens' AdminRespondToAuthChallengeResponse (Maybe AuthenticationResultType) Source #
The result returned by the server in response to the authentication request.
artacrsSession :: Lens' AdminRespondToAuthChallengeResponse (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.
artacrsResponseStatus :: Lens' AdminRespondToAuthChallengeResponse Int Source #
- - | The response status code.