The resetPassword mutation is now deprecated

What is changing?

The resetPassword GraphQL mutation is now deprecated.

• It is replaced by the resetUserPassword mutation.
• A preliminary removal date is set for 1st June 2025.

What do I need to do?

Please migrate to the resetUserPassword mutation, which is now available to use.

The overall password reset flow is unchanged, but there are some tweaks to the input/output parameters:

Before

mutation resetPasswordDeprecated {
  resetPassword(
    input: {userId: "123", password: "new-password-789", token: "token-from-presigned-url"}
  ) {
    errors {
      ... on SerializerFieldErrorsType {
        field
        errors {
          ... on SerializerErrorType {
            message
            code
          }
        }
      }
    }
  }
}

After

mutation resetPasswordNew {
  resetUserPassword(
    input: {userId: "123", newPassword: "new-password-789", token: "token-from-presigned-url"}
  ) {
    passwordUpdated
    failureReasons
  }
}

Notes:

• failureReasons is a list of password validation errors, if any exist.
• Authorisation errors may be raised via the built-in GraphQL errors entry.