ICognitoIdentityProviderAdminRespondToAuthChallengeRequest

Interface in AWS.CognitoIdentityProvider

Interface for AdminRespondToAuthChallenge requests.

Ancestors

• ICognitoIdentityProviderRequest

Properties

AnalyticsMetadata

property AnalyticsMetadata: ICognitoIdentityProviderAnalyticsMetadataType

Type: ICognitoIdentityProviderAnalyticsMetadataType

Specify configuration for analytics metadata collection for Amazon Pinpoint metrics.

ChallengeName

property ChallengeName: string

Specify the challenge name.

ChallengeResponses

property ChallengeResponses: TDictionary<string, string>

Specify the challenge responses.

These are inputs corresponding to the value of ChallengeName. For example:

If app client is configured with client secret, SECRET_HASH applies to all challenge types. TCognitoIdentityProviderSecretHashEncoder can be used to generate a value for this.

ClientId

property ClientId: string

Specify the app client ID.

ClientMetadata

property ClientMetadata: TDictionary<string, string>

Specify a custom map of key-value pairs that you can provide as input for certain custom workflows triggered by this action.

ContextData

property ContextData: ICognitoIdentityProviderContextDataType

Type: ICognitoIdentityProviderContextDataType

Specify contextual data about your user session.

The data can include attributes such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of the authentication event based on the context that your app generates and passes to Amazon Cognito.

Session

property Session: string

Specify the session returned from a call to AdminInitiateAuth or AdminRespondToAuthChallenge.

UserPoolId

property UserPoolId: string

Specify the ID of the user pool.

Methods

AddChallengeResponse

procedure AddChallengeResponse(const AKey, AValue: string);

Add a key-value pair to ChallengeResponses.

Parameters

Name	Description
AKey	Specify the key.
AValue	Specify the value.

AddClientMetadata

procedure AddClientMetadata(const AKey, AValue: string);

Add a key-value pair to ClientMetadata.

Parameters

Name	Description
AKey	Specify the key of the metadata.
AValue	Specify the value of the metadata.