cognitoidentityprovider_confirm_forgot_password: Allows a user to enter a confirmation code to reset a forgotten password

Description

Allows a user to enter a confirmation code to reset a forgotten password.

Usage

cognitoidentityprovider_confirm_forgot_password(ClientId, SecretHash,
  Username, ConfirmationCode, Password, AnalyticsMetadata,
  UserContextData)

Arguments

ClientId

[required] The app client ID of the app associated with the user pool.

SecretHash

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

Username

[required] The user name of the user for whom you want to enter a code to retrieve a forgotten password.

ConfirmationCode

[required] The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

Password

[required] The password sent by a user's request to retrieve a forgotten password.

AnalyticsMetadata

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

UserContextData

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.

Request syntax

svc$confirm_forgot_password(
  ClientId = "string",
  SecretHash = "string",
  Username = "string",
  ConfirmationCode = "string",
  Password = "string",
  AnalyticsMetadata = list(
    AnalyticsEndpointId = "string"
  ),
  UserContextData = list(
    EncodedData = "string"
  )
)