Account management

Changes a user's password.

Changes the password for an account on this homeserver.

This API endpoint uses the User-Interactive Authentication API to ensure the user changing the password is actually the owner of the account.

An access token should be submitted to this endpoint if the client has an active session.

The homeserver may change the flows available depending on whether a valid access token is provided. The homeserver SHOULD NOT revoke the access token provided in the request. Whether other access tokens for the user are revoked depends on the request parameters.

This endpoint uses capabilities negotiation. Clients SHOULD check the value of the m.change_password capability to determine if this endpoint is available.

post/_matrix/client/v3/account/password

Request

Base URL
https://matrix.org
Auth
- none
- or API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/account/password/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

logout_devicesboolean

Whether the user's other access tokens, and their associated devices, should be revoked if the request succeeds. Defaults to true.

When false, the server can still take advantage of the soft logout method for the user's remaining devices.

new_passwordstring required

The new password for the account.

Example request

{
  "auth": {
    "example_credential": "verypoorsharedsecret",
    "session": "xxxxx",
    "type": "example.type.foo"
  },
  "logout_devices": true,
  "new_password": "ihatebananas"
}

Response

The password has been changed.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.