View source: R/cognitoidentityprovider_operations.R
cognitoidentityprovider_admin_respond_to_auth_challenge | R Documentation |
Responds to an authentication challenge, as an administrator.
See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_respond_to_auth_challenge/ for full documentation.
cognitoidentityprovider_admin_respond_to_auth_challenge(
UserPoolId,
ClientId,
ChallengeName,
ChallengeResponses = NULL,
Session = NULL,
AnalyticsMetadata = NULL,
ContextData = NULL,
ClientMetadata = NULL
)
UserPoolId |
[required] The ID of the Amazon Cognito user pool. |
ClientId |
[required] The app client ID. |
ChallengeName |
[required] The challenge name. For more information, see
|
ChallengeResponses |
The challenge responses. These are inputs corresponding to the value of
The value of the For more information about |
Session |
The session that should be passed both ways in challenge-response calls
to the service. If an
|
AnalyticsMetadata |
The analytics metadata for collecting Amazon Pinpoint metrics for
|
ContextData |
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests. |
ClientMetadata |
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that you have assigned to the following triggers:
When Amazon Cognito invokes any of these functions, it passes a JSON
payload, which the function receives as input. This payload contains a
For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.