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 |
Initiates the authentication flow.
- initiateAuth :: AuthFlowType -> Text -> InitiateAuth
- data InitiateAuth
- iaClientMetadata :: Lens' InitiateAuth (HashMap Text Text)
- iaAuthParameters :: Lens' InitiateAuth (HashMap Text Text)
- iaAuthFlow :: Lens' InitiateAuth AuthFlowType
- iaClientId :: Lens' InitiateAuth Text
- initiateAuthResponse :: Int -> InitiateAuthResponse
- data InitiateAuthResponse
- iarsChallengeName :: Lens' InitiateAuthResponse (Maybe ChallengeNameType)
- iarsChallengeParameters :: Lens' InitiateAuthResponse (HashMap Text Text)
- iarsAuthenticationResult :: Lens' InitiateAuthResponse (Maybe AuthenticationResultType)
- iarsSession :: Lens' InitiateAuthResponse (Maybe Text)
- iarsResponseStatus :: Lens' InitiateAuthResponse Int
Creating a Request
Creates a value of InitiateAuth
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaClientMetadata
- This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.iaAuthParameters
- The authentication parameters. These are inputs corresponding to theAuthFlow
that you are invoking. The required values depend on the value ofAuthFlow
: * ForUSER_SRP_AUTH
:USERNAME
(required),SRP_A
(required),SECRET_HASH
(required if the app client is configured with a client secret),DEVICE_KEY
* ForREFRESH_TOKEN_AUTH/REFRESH_TOKEN
:USERNAME
(required),SECRET_HASH
(required if the app client is configured with a client secret),REFRESH_TOKEN
(required),DEVICE_KEY
* ForCUSTOM_AUTH
:USERNAME
(required),SECRET_HASH
(if app client is configured with client secret),DEVICE_KEY
iaAuthFlow
- The authentication flow for this call to execute. The API action will depend on this value. For example: *REFRESH_TOKEN_AUTH
will take in a valid refresh token and return new tokens. *USER_SRP_AUTH
will take inUSERNAME
andSRP_A
and return the SRP variables to be used for next challenge execution. Valid values include: *USER_SRP_AUTH
: Authentication flow for the Secure Remote Password (SRP) protocol. *REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. *CUSTOM_AUTH
: Custom authentication flow.ADMIN_NO_SRP_AUTH
is not a valid value.iaClientId
- The app client ID.
data InitiateAuth Source #
Initiates the authentication request.
See: initiateAuth
smart constructor.
Request Lenses
iaClientMetadata :: Lens' InitiateAuth (HashMap Text Text) Source #
This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.
iaAuthParameters :: Lens' InitiateAuth (HashMap Text Text) Source #
The authentication parameters. These are inputs corresponding to the AuthFlow
that you are invoking. The required values depend on the value of AuthFlow
: * For USER_SRP_AUTH
: USERNAME
(required), SRP_A
(required), SECRET_HASH
(required if the app client is configured with a client secret), DEVICE_KEY
* For REFRESH_TOKEN_AUTH/REFRESH_TOKEN
: USERNAME
(required), SECRET_HASH
(required if the app client is configured with a client secret), REFRESH_TOKEN
(required), DEVICE_KEY
* For CUSTOM_AUTH
: USERNAME
(required), SECRET_HASH
(if app client is configured with client secret), DEVICE_KEY
iaAuthFlow :: Lens' InitiateAuth AuthFlowType Source #
The authentication flow for this call to execute. The API action will depend on this value. For example: * REFRESH_TOKEN_AUTH
will take in a valid refresh token and return new tokens. * USER_SRP_AUTH
will take in USERNAME
and SRP_A
and return the SRP variables to be used for next challenge execution. Valid values include: * USER_SRP_AUTH
: Authentication flow for the Secure Remote Password (SRP) protocol. * REFRESH_TOKEN_AUTH
/REFRESH_TOKEN
: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. * CUSTOM_AUTH
: Custom authentication flow. ADMIN_NO_SRP_AUTH
is not a valid value.
iaClientId :: Lens' InitiateAuth Text Source #
The app client ID.
Destructuring the Response
Creates a value of InitiateAuthResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iarsChallengeName
- The name of the challenge which you are responding to with this call. This is returned to you in theAdminInitiateAuth
response if you need to pass another challenge. Valid values include the following. Note that all of these challenges requireUSERNAME
andSECRET_HASH
(if applicable) in the parameters. *SMS_MFA
: Next challenge is to supply anSMS_MFA_CODE
, delivered via SMS. *PASSWORD_VERIFIER
: Next challenge is to supplyPASSWORD_CLAIM_SIGNATURE
,PASSWORD_CLAIM_SECRET_BLOCK
, andTIMESTAMP
after the client-side SRP calculations. *CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. *DEVICE_SRP_AUTH
: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. *DEVICE_PASSWORD_VERIFIER
: Similar toPASSWORD_VERIFIER
, but for devices only. *NEW_PASSWORD_REQUIRED
: For users which are required to change their passwords after successful first login. This challenge should be passed withNEW_PASSWORD
and any other required attributes.iarsChallengeParameters
- The challenge parameters. These are returned to you in theInitiateAuth
response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge
). All challenges requireUSERNAME
andSECRET_HASH
(if applicable).iarsAuthenticationResult
- The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens,ChallengeName
,ChallengeParameters
, andSession
are returned.iarsSession
- 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.iarsResponseStatus
- -- | The response status code.
data InitiateAuthResponse Source #
Initiates the authentication response.
See: initiateAuthResponse
smart constructor.
Response Lenses
iarsChallengeName :: Lens' InitiateAuthResponse (Maybe ChallengeNameType) Source #
The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth
response if you need to pass another challenge. Valid values include the following. Note that all of these challenges require USERNAME
and SECRET_HASH
(if applicable) in the parameters. * SMS_MFA
: Next challenge is to supply an SMS_MFA_CODE
, delivered via SMS. * PASSWORD_VERIFIER
: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE
, PASSWORD_CLAIM_SECRET_BLOCK
, and TIMESTAMP
after the client-side SRP calculations. * CUSTOM_CHALLENGE
: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. * DEVICE_SRP_AUTH
: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. * DEVICE_PASSWORD_VERIFIER
: Similar to PASSWORD_VERIFIER
, but for devices only. * NEW_PASSWORD_REQUIRED
: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD
and any other required attributes.
iarsChallengeParameters :: Lens' InitiateAuthResponse (HashMap Text Text) Source #
The challenge parameters. These are returned to you in the InitiateAuth
response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge
). All challenges require USERNAME
and SECRET_HASH
(if applicable).
iarsAuthenticationResult :: Lens' InitiateAuthResponse (Maybe AuthenticationResultType) Source #
The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName
, ChallengeParameters
, and Session
are returned.
iarsSession :: Lens' InitiateAuthResponse (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.
iarsResponseStatus :: Lens' InitiateAuthResponse Int Source #
- - | The response status code.