The removeRole() GraphQL mutation is used to remove a role. It's only usable if roles are not managed externally (e.g. in LDAP).

For more information on roles in LogScale, see the Manage users & permissions documentation page. You may also want to look at the Manage users & permissions page for related information.

Syntax

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

graphql
removeRole(
      roleId: string!
   ): BooleanResultType!

Returned Datatypes

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

Table: BooleanResultType

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.
resultsbooleanyes Whether the mutation was performed.