You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::ConfirmForgotPasswordRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ConfirmForgotPasswordRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  confirmation_code: "ConfirmationCodeType", # required
  password: "PasswordType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    encoded_data: "StringType",
  },
}

The request representing the confirmation for a password reset.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

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

Returns:

#client_idString

The app client ID of the app associated with the user pool.

Returns:

  • (String)

    The app client ID of the app associated with the user pool.

#confirmation_codeString

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

Returns:

  • (String)

    The confirmation code sent by a user\'s request to retrieve a forgotten password.

#passwordString

The password sent by a user\'s request to retrieve a forgotten password.

Returns:

  • (String)

    The password sent by a user\'s request to retrieve a forgotten password.

#secret_hashString

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.

Returns:

  • (String)

    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.

#user_context_dataTypes::UserContextDataType

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.

Returns:

  • (Types::UserContextDataType)

    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.

#usernameString

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

Returns:

  • (String)

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