ICognitoIdentityProviderConfirmForgotPasswordRequest
Interface in AWS.CognitoIdentityProvider
Interface for ConfirmForgotPassword requests.
Ancestors
Properties
AnalyticsMetadata
property AnalyticsMetadata: ICognitoIdentityProviderAnalyticsMetadataType
Type: ICognitoIdentityProviderAnalyticsMetadataType
Specify configuration for analytics metadata collection for Amazon Pinpoint metrics.
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.
ConfirmationCode
property ConfirmationCode: string
Specify the confirmation code from the user's request to reset their password.
Password
property Password: string
Specify the new password that the user wants to set.
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 of the user wanting to recover from a forgotten password.
Methods
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. |