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

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

Overview

The request representing the confirmation for a password reset.

See Also:

Constant Summary collapse

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

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:



3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

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

#client_id ⇒ String

The ID of the app client where the user wants to reset their password. This parameter is an identifier of the client application that users are resetting their password from, but this operation resets users' irrespective of the app clients they sign in to.

Returns:

  • (String) 


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  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 ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, 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 ConfirmForgotPassword 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.

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.

Returns:

  • (Hash<String,String>) 


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

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

#confirmation_code ⇒ String

The confirmation code that your user pool delivered when your user requested to reset their password.

Returns:

  • (String) 


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

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

#password ⇒ String

The new password that your user wants to set.

Returns:

  • (String) 


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  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.

Returns:

  • (String) 


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  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.

Returns:



3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

class ConfirmForgotPasswordRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :confirmation_code,
  :password,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  SENSITIVE = [:client_id, :secret_hash, :username, :password, :user_context_data]
  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) 


3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3259

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