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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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

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

Returns:



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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’ passwords for all app clients in the user pool.

Returns:

  • (String) 


3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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 [ Customizing user pool Workflows with 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>) 


3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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 sent in response to an

AdminResetUserPassword][1

or a [ForgotPassword] request.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminResetUserPassword.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html

Returns:

  • (String) 


3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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) 


3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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

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

Returns:

  • (String) 


3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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:



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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


3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3299

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