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

Class: Aws::CognitoIdentityProvider::Types::ForgotPasswordRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass ForgotPasswordRequest data as a hash:

{
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
}

Represents the request to reset a user's password.

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

The ID of the client associated with the user pool.

Returns:

  • (String)


2875
2876
2877
2878
2879
2880
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2875

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username)
  include Aws::Structure
end

#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)


2875
2876
2877
2878
2879
2880
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2875

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username)
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


2875
2876
2877
2878
2879
2880
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2875

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username)
  include Aws::Structure
end