amazonka-cognito-idp-1.6.1: Amazon Cognito Identity Provider SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Contents

Description

Responds to an authentication challenge, as an administrator.

Requires developer credentials.

Synopsis

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:

  • artacContextData - 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.
  • artacAnalyticsMetadata - The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
  • artacChallengeResponses - 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 - 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 - The ID of the Amazon Cognito user pool.
  • artacClientId - The app client ID.
  • artacChallengeName - The challenge name. For more information, see .

data AdminRespondToAuthChallenge Source #

The request to respond to the authentication challenge, as an administrator.

See: adminRespondToAuthChallenge smart constructor.

Instances
Eq AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Data AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Methods

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

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

toConstr :: AdminRespondToAuthChallenge -> Constr #

dataTypeOf :: AdminRespondToAuthChallenge -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AdminRespondToAuthChallenge) #

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

gmapT :: (forall b. Data b => b -> b) -> AdminRespondToAuthChallenge -> AdminRespondToAuthChallenge #

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

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

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

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

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

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

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

Show AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Generic AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Associated Types

type Rep AdminRespondToAuthChallenge :: Type -> Type #

Hashable AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

ToJSON AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

AWSRequest AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Associated Types

type Rs AdminRespondToAuthChallenge :: Type #

ToHeaders AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

ToPath AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

ToQuery AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

NFData AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

type Rep AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

type Rep AdminRespondToAuthChallenge = D1 (MetaData "AdminRespondToAuthChallenge" "Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "AdminRespondToAuthChallenge'" PrefixI True) ((S1 (MetaSel (Just "_artacContextData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContextDataType)) :*: (S1 (MetaSel (Just "_artacAnalyticsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AnalyticsMetadataType)) :*: S1 (MetaSel (Just "_artacChallengeResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) :*: ((S1 (MetaSel (Just "_artacSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_artacUserPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_artacClientId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 (MetaSel (Just "_artacChallengeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ChallengeNameType)))))
type Rs AdminRespondToAuthChallenge Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Request Lenses

artacContextData :: Lens' AdminRespondToAuthChallenge (Maybe ContextDataType) Source #

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.

artacAnalyticsMetadata :: Lens' AdminRespondToAuthChallenge (Maybe AnalyticsMetadataType) Source #

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

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.

artacChallengeName :: Lens' AdminRespondToAuthChallenge ChallengeNameType Source #

The challenge name. For more information, see .

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 .
  • artacrsChallengeParameters - The challenge parameters. For more information, see .
  • 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 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.
  • artacrsResponseStatus - -- | The response status code.

data AdminRespondToAuthChallengeResponse Source #

Responds to the authentication challenge, as an administrator.

See: adminRespondToAuthChallengeResponse smart constructor.

Instances
Eq AdminRespondToAuthChallengeResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Data AdminRespondToAuthChallengeResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Methods

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

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

toConstr :: AdminRespondToAuthChallengeResponse -> Constr #

dataTypeOf :: AdminRespondToAuthChallengeResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AdminRespondToAuthChallengeResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> AdminRespondToAuthChallengeResponse -> AdminRespondToAuthChallengeResponse #

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

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

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

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

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

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

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

Show AdminRespondToAuthChallengeResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Generic AdminRespondToAuthChallengeResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

NFData AdminRespondToAuthChallengeResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

type Rep AdminRespondToAuthChallengeResponse Source # 
Instance details

Defined in Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

type Rep AdminRespondToAuthChallengeResponse = D1 (MetaData "AdminRespondToAuthChallengeResponse" "Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge" "amazonka-cognito-idp-1.6.1-IATNKTGZSOc4TejpW4Ifw7" False) (C1 (MetaCons "AdminRespondToAuthChallengeResponse'" PrefixI True) ((S1 (MetaSel (Just "_artacrsChallengeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChallengeNameType)) :*: S1 (MetaSel (Just "_artacrsChallengeParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) :*: (S1 (MetaSel (Just "_artacrsAuthenticationResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthenticationResultType)) :*: (S1 (MetaSel (Just "_artacrsSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_artacrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

artacrsChallengeName :: Lens' AdminRespondToAuthChallengeResponse (Maybe ChallengeNameType) Source #

The name of the challenge. For more information, see .

artacrsChallengeParameters :: Lens' AdminRespondToAuthChallengeResponse (HashMap Text Text) Source #

The challenge parameters. For more information, see .

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 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.