Class: Aws::CognitoIdentityProvider::Types::AdminResetUserPasswordRequest

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

Overview

Represents the request to reset a user's password as an administrator.

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#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. The AdminResetUserPassword API operation invokes the function that is assigned to the custom message 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 AdminResetUserPassword 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>) 


1572
1573
1574
1575
1576
1577
1578
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1572

class AdminResetUserPasswordRequest < Struct.new(
  :user_pool_id,
  :username,
  :client_metadata)
  SENSITIVE = [:username]
  include Aws::Structure
end

#user_pool_id ⇒ String

The ID of the user pool where you want to reset the user's password.

Returns:

  • (String) 


1572
1573
1574
1575
1576
1577
1578
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1572

class AdminResetUserPasswordRequest < Struct.new(
  :user_pool_id,
  :username,
  :client_metadata)
  SENSITIVE = [: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) 


1572
1573
1574
1575
1576
1577
1578
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1572

class AdminResetUserPasswordRequest < Struct.new(
  :user_pool_id,
  :username,
  :client_metadata)
  SENSITIVE = [:username]
  include Aws::Structure
end