Skip to content
Last update: April 11, 2024

requestPasswordReset query

This connection is used to initiate a password reset process for a user.

Arguments

Field Description
loginOrEmail String! The login or email of the user for whom the password reset is requested.
urlSuffix String An optional URL suffix that can be appended to the password reset URL.

Possible returns

Possible return Description
Boolean Indicates whether the password reset request was successfully initiated.

Examples

1
2
3
4
5
6
query {
  requestPasswordReset(
    loginOrEmail: "User_1"
    urlSuffix: "reset-password/reset"
  )
}

1
2
3
4
5
{
  "data": {
    "requestPasswordReset": true
  }
}