API Stability Long-Term

The revokePendingUser() GraphQL mutation is used to revoke a pending user. Once revoked, the invitation link sent to the user becomes invalid.

For more information on user authorization, see the Manage users & permissions documentation page.

Syntax

Below is the syntax for the revokePendingUser() mutation field:

graphql
revokePendingUser(
     input: TokenInput!
   ): boolean!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  revokePendingUser( input: {
     token: "abc123"
  } )
}
Example Responses
Show:
json
{
  "data": {
    "revokePendingUser": true
  }
}

Given Datatypes

For TokenInput, there is only one parameter that may be given. It's described in the table here:

Table: TokenInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 20, 2024
tokenstringyes Long-TermThe unique token to use.