Skip to main content

sendPasswordResetLink

Requires permission users:user:update.

Emails an active staff user in your organization a link to set their password: an invite link (valid 24 hours) if they have no password yet, a reset link (valid 1 hour) if they do. The administrator never sets, sees or receives the password or the link. You need every permission the target user holds, a refusal is returned as an error, and one link can be sent to a user per minute. Returns true once the link is sent. Needs users:user:update.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

mutation SendPasswordResetLink($userId: ID!) {
  sendPasswordResetLink(userId: $userId)
}

Variables:

{
  "userId": "id"
}

Response:

{
  "data": {
    "sendPasswordResetLink": true
  }
}
sendPasswordResetLink(
  userId: ID!
): Boolean!

Arguments​

sendPasswordResetLink.userId ● ID! non-null scalar​

The ID of the user.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.