ICognitoIdentityProviderForgotPasswordRequest

Interface in AWS.CognitoIdentityProvider

Interface for ForgotPassword requests.

Ancestors

• ICognitoIdentityProviderRequest

Properties

AnalyticsMetadata

property AnalyticsMetadata: ICognitoIdentityProviderAnalyticsMetadataType

Type: ICognitoIdentityProviderAnalyticsMetadataType

Specify the Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

ClientId

property ClientId: string

Specify the ID of the client associated with the user pool.

ClientMetadata

property ClientMetadata: TDictionary<string, string>

Specifies a map of key-value pairs that you can provide as input for any custom workflows that this action triggers.

Use AddClientMetadata to populate values.

SecretHash

property SecretHash: string

Provide a key-hashed message authentication code (HMAC) calculated using the secret key of a user pool client and the username plus the client ID in the message.

TCognitoIdentityProviderSecretHashEncoder can be used to generate a value for this.

UserContextData

property UserContextData: ICognitoIdentityProviderUserContextDataType

Type: ICognitoIdentityProviderUserContextDataType

Contextual data about the 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.

Username

property Username: string

Specify the username or alias of the user.

Methods

AddClientMetadata

procedure AddClientMetadata(const AKey, AValue: string);

Add a key-value pair to ClientMetadata.

Parameters

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