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",
  user_context_data: {
    encoded_data: "StringType",
  },
  username: "UsernameType", # required
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
}

Represents the request to reset a user's password.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

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



3684
3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3684

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

#client_idString

The ID of the client associated with the user pool.

Returns:

  • (String)


3684
3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3684

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata)
  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)


3684
3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3684

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

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



3684
3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3684

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata)
  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)


3684
3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3684

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