Network.AWS.CognitoIdentityProvider.AdminRespondToAuthChallenge

Responds to an authentication challenge, as an administrator.

Requires developer credentials.

Creating a Request

adminRespondToAuthChallenge

Arguments

:: Text

artacUserPoolId

-> Text

artacClientId

-> ChallengeNameType

artacChallengeName

-> AdminRespondToAuthChallenge

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

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

See: adminRespondToAuthChallenge smart constructor.

Instances

Eq AdminRespondToAuthChallenge

Methods

(==) :: AdminRespondToAuthChallenge -> AdminRespondToAuthChallenge -> Bool

(/=) :: AdminRespondToAuthChallenge -> AdminRespondToAuthChallenge -> Bool

Data 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

Methods

showsPrec :: Int -> AdminRespondToAuthChallenge -> ShowS

show :: AdminRespondToAuthChallenge -> String

showList :: [AdminRespondToAuthChallenge] -> ShowS

Generic AdminRespondToAuthChallenge

Associated Types

type Rep AdminRespondToAuthChallenge :: * -> *

Methods

from :: AdminRespondToAuthChallenge -> Rep AdminRespondToAuthChallenge x

to :: Rep AdminRespondToAuthChallenge x -> AdminRespondToAuthChallenge

Hashable AdminRespondToAuthChallenge

Methods

hashWithSalt :: Int -> AdminRespondToAuthChallenge -> Int

hash :: AdminRespondToAuthChallenge -> Int

ToJSON AdminRespondToAuthChallenge

Methods

toJSON :: AdminRespondToAuthChallenge -> Value

toEncoding :: AdminRespondToAuthChallenge -> Encoding

toJSONList :: [AdminRespondToAuthChallenge] -> Value

toEncodingList :: [AdminRespondToAuthChallenge] -> Encoding

NFData AdminRespondToAuthChallenge

Methods

rnf :: AdminRespondToAuthChallenge -> ()

AWSRequest AdminRespondToAuthChallenge

Associated Types

type Rs AdminRespondToAuthChallenge :: *

Methods

request :: AdminRespondToAuthChallenge -> Request AdminRespondToAuthChallenge

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * AdminRespondToAuthChallenge -> ClientResponse -> m (Response AdminRespondToAuthChallenge)

ToHeaders AdminRespondToAuthChallenge

Methods

toHeaders :: AdminRespondToAuthChallenge -> [Header]

ToPath AdminRespondToAuthChallenge

Methods

toPath :: AdminRespondToAuthChallenge -> ByteString

ToQuery AdminRespondToAuthChallenge

Methods

toQuery :: AdminRespondToAuthChallenge -> QueryString

type Rep AdminRespondToAuthChallenge

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

type Rs AdminRespondToAuthChallenge

type Rs AdminRespondToAuthChallenge = AdminRespondToAuthChallengeResponse

Request Lenses

artacContextData :: Lens' AdminRespondToAuthChallenge (Maybe ContextDataType)

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)

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

artacChallengeResponses :: Lens' AdminRespondToAuthChallenge (HashMap Text Text)

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)

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

The ID of the Amazon Cognito user pool.

artacClientId :: Lens' AdminRespondToAuthChallenge Text

The app client ID.

artacChallengeName :: Lens' AdminRespondToAuthChallenge ChallengeNameType

The challenge name. For more information, see .

Destructuring the Response

adminRespondToAuthChallengeResponse

Arguments

:: Int

artacrsResponseStatus

-> AdminRespondToAuthChallengeResponse

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

Responds to the authentication challenge, as an administrator.

See: adminRespondToAuthChallengeResponse smart constructor.

Instances

Eq AdminRespondToAuthChallengeResponse

Methods

(==) :: AdminRespondToAuthChallengeResponse -> AdminRespondToAuthChallengeResponse -> Bool

(/=) :: AdminRespondToAuthChallengeResponse -> AdminRespondToAuthChallengeResponse -> Bool

Data AdminRespondToAuthChallengeResponse

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

Methods

showsPrec :: Int -> AdminRespondToAuthChallengeResponse -> ShowS

show :: AdminRespondToAuthChallengeResponse -> String

showList :: [AdminRespondToAuthChallengeResponse] -> ShowS

Generic AdminRespondToAuthChallengeResponse

Associated Types

type Rep AdminRespondToAuthChallengeResponse :: * -> *

Methods

from :: AdminRespondToAuthChallengeResponse -> Rep AdminRespondToAuthChallengeResponse x

to :: Rep AdminRespondToAuthChallengeResponse x -> AdminRespondToAuthChallengeResponse

NFData AdminRespondToAuthChallengeResponse

Methods

rnf :: AdminRespondToAuthChallengeResponse -> ()

type Rep AdminRespondToAuthChallengeResponse

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

Response Lenses

artacrsChallengeName :: Lens' AdminRespondToAuthChallengeResponse (Maybe ChallengeNameType)

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

artacrsChallengeParameters :: Lens' AdminRespondToAuthChallengeResponse (HashMap Text Text)

The challenge parameters. For more information, see .

artacrsAuthenticationResult :: Lens' AdminRespondToAuthChallengeResponse (Maybe AuthenticationResultType)

The result returned by the server in response to the authentication request.

artacrsSession :: Lens' AdminRespondToAuthChallengeResponse (Maybe Text)

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 :: Lens' AdminRespondToAuthChallengeResponse Int

• - | The response status code.