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

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

Overview

Represents the request to reset a user’s password.

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_id, :secret_hash, :user_context_data, :username]

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadata ⇒ Types::AnalyticsMetadataType

Information that supports analytics outcomes with Amazon Pinpoint, including the user’s endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

Returns:



6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6124

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username]
  include Aws::Structure
end

#client_id ⇒ String

The ID of the user pool app client associated with the current signed-in user.

Returns:

  • (String) 


6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6124

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username]
  include Aws::Structure
end

#client_metadata ⇒ Hash<String,String>

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: *pre sign-up*, *custom message*, and *user migration*. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a ‘clientMetadata` attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in Lambda, you can process the `clientMetadata` value to enhance your workflow for your specific needs.

For more information, see [ Using Lambda triggers] in the *Amazon Cognito Developer Guide*.

<note markdown=“1”> When you use the ‘ClientMetadata` parameter, note that Amazon Cognito won’t do the following:

* Store the `ClientMetadata` value. This data is available only to
 Lambda triggers that are assigned to a user pool to support custom
 workflows. If your user pool configuration doesn't include
 triggers, the `ClientMetadata` parameter serves no purpose.

  • Validate the ‘ClientMetadata` value.

  • Encrypt the ‘ClientMetadata` value. Don’t send sensitive information in this parameter.

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html

Returns:

  • (Hash<String,String>) 


6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6124

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username]
  include Aws::Structure
end

#secret_hash ⇒ 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. For more information about ‘SecretHash`, see [Computing secret hash values].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash

Returns:

  • (String) 


6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6124

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username]
  include Aws::Structure
end

#user_context_data ⇒ Types::UserContextDataType

Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see [Collecting data for threat protection in applications].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html

Returns:



6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6124

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username]
  include Aws::Structure
end

#username ⇒ String

The name of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

  • (String) 


6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6124

class ForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :user_context_data,
  :username,
  :analytics_metadata,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :user_context_data, :username]
  include Aws::Structure
end