The removeUserById() GraphQL mutation is used to Remove a user by their identifier.

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

Syntax

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

graphql
removeUserById(
      input: RemoveUserByIdInput!
   ): RemoveUserByIdMutation!

Given Datatypes

The given datatype RemoveUserByIdInput has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: RemoveUserByIdInput

ParameterTypeRequiredDefaultDescription
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 19, 2024
idstringyes The unique identifier of the user to be removed.

Returned Datatypes

The returned datatype RemoveUserByIdMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: RemoveUserByIdMutation

ParameterTypeRequiredDefaultDescription
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: Oct 3, 2024
userUseryes The user to remove from the mutation. See User.