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

For more information on user authorization, see the Managing 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

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier of the user to be removed.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


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

ParameterTypeRequired[a]DefaultDescription
userUseryes The user to remove from the mutation (see User Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.