Skip to main content

profilePasswordUpdate

Changes the password of the signed-in person.

Business Rules​

  • The caller must be signed in as a person.
  • The current password must match.
  • The new password must meet the rules returned by passwordRules.
  • Other sessions of the person stay signed in.

Error Scenarios​

  • CurrentPasswordIncorrect: the current password does not match.
  • InvalidPassword: the new password breaks one or more password rules.

Permissions Required​

  • global:update_my_password, held by every person role.
profilePasswordUpdate(
  input: ProfilePasswordUpdateInput!
): ProfilePasswordUpdatePayload

Arguments​

profilePasswordUpdate.input ● ProfilePasswordUpdateInput! non-null input common​

Parameters for ProfilePasswordUpdate

Type​

ProfilePasswordUpdatePayload object common​

Autogenerated return type of ProfilePasswordUpdate.