API Stability Long-Term

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!

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

Show:
graphql
mutation {
  removeRole( roleId: "pFkHHTbDSlcTo3elkos3Qd0ySW6Kduhb")
  { result }
}
Example Responses
Show:
json
{
  "data": {
    "removeRole": {
      "result": true
    }
  }
}

Returned Datatypes

BooleanResultType has a simple, boolean parameter. See the example above to understand better.

Table: BooleanResultType

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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.