Skip to main content

changePassword

Changes the authenticated user's password after verifying the current password. Requires a valid session token. Returns true on success. Refuses with extensions.code INVALID_CURRENT_PASSWORD (403) when the current password is wrong, and PASSWORD_NOT_SET (409) when the account has no password to change — use setInitialPassword for that, which needs only the session. NEITHER of those means the session is invalid, and neither is UNAUTHENTICATED: both were until v1.60.0, so a client that signs the user out on UNAUTHENTICATED was signing them out over a typo. Every OTHER session for the account is revoked (with the app tokens minted from it); the session that made this call stays valid, so the client does not need to sign in again.

changePassword(
  currentPassword: String!
  newPassword: String!
): Boolean!

Arguments​

changePassword.currentPassword ● String! non-null scalar​

The user's current password, for verification.

changePassword.newPassword ● String! non-null scalar​

The new password to set (min 8 characters).

Type​

Boolean scalar​

The Boolean scalar type represents true or false.