Users

post/users/me/password

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/users/me/password
  • Auth: HTTP bearer

Request body

current_passwordstring required
mfa_codestring nullable

TOTP code (or recovery code). Required iff the user has MFA enabled.

new_passwordstring required
revoke_other_sessionsboolean

When true, every session OTHER than the one making this request is revoked. Defaults to false; the UI surfaces this as a checkbox.

Example request

{
  "current_password": "current_password_value",
  "mfa_code": "123456",
  "new_password": "new_password_value"
}

Response

Password updated

Changes

No recorded changes to this operation across all 53 revisions of this API.