Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.CognitoIdentityProvider.InitiateAuth
Description
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
Arguments
:: AuthFlowType | |
-> Text | |
-> InitiateAuth |
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
- The client app's metadata.iaAuthParameters
- The authentication parameters.iaAuthFlow
- The authentication flow.iaClientId
- The client ID.
data InitiateAuth #
Initiates the authentication request.
See: initiateAuth
smart constructor.
Instances
Request Lenses
iaClientMetadata :: Lens' InitiateAuth (HashMap Text Text) #
The client app's metadata.
iaAuthParameters :: Lens' InitiateAuth (HashMap Text Text) #
The authentication parameters.
iaAuthFlow :: Lens' InitiateAuth AuthFlowType #
The authentication flow.
iaClientId :: Lens' InitiateAuth Text #
The client ID.
Destructuring the Response
Arguments
:: Int | |
-> InitiateAuthResponse |
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.iarsChallengeParameters
- The challenge parameters.iarsAuthenticationResult
- The result returned by the server in response to the request to initiate authentication.iarsSession
- The session.iarsResponseStatus
- -- | The response status code.
data InitiateAuthResponse #
Initiates the authentication response.
See: initiateAuthResponse
smart constructor.
Response Lenses
iarsChallengeName :: Lens' InitiateAuthResponse (Maybe ChallengeNameType) #
The name of the challenge.
iarsChallengeParameters :: Lens' InitiateAuthResponse (HashMap Text Text) #
The challenge parameters.
iarsAuthenticationResult :: Lens' InitiateAuthResponse (Maybe AuthenticationResultType) #
The result returned by the server in response to the request to initiate authentication.
iarsSession :: Lens' InitiateAuthResponse (Maybe Text) #
The session.
iarsResponseStatus :: Lens' InitiateAuthResponse Int #
- - | The response status code.