CognitoIdentityProvider / Client / change_password

change_password#

CognitoIdentityProvider.Client.change_password(**kwargs)#

Changes the password for a specified user in a user pool.

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

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.change_password(
    PreviousPassword='string',
    ProposedPassword='string',
    AccessToken='string'
)
Parameters:

  • PreviousPassword (string) – 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.

  • ProposedPassword (string) –

    [REQUIRED]

    The new password.

  • AccessToken (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The response from the server to the change password request.

Exceptions