AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ChangePassword operation. Changes the password for the currently signed-in user.

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.ChangePasswordRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class ChangePasswordRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The ChangePasswordRequest type exposes the following members

Constructors

NameDescription
Public Method ChangePasswordRequest()

Properties

NameTypeDescription
Public Property AccessToken System.String

Gets and sets the property AccessToken.

A valid access token that Amazon Cognito issued to the user whose password you want to change.

Public Property PreviousPassword System.String

Gets and sets the property PreviousPassword.

The user's previous password. Required if the user has a password. If the user has no password and only signs in with passwordless authentication options, you can omit this parameter.

Public Property ProposedPassword System.String

Gets and sets the property ProposedPassword.

A new password that you prompted the user to enter in your application.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5