GraphiQL open_in_new

OBJECT

UserRole

A system-level access role for users.

link GraphQL Schema definition

  • type UserRole {
  • # The unique ID.
  • id: Int!
  • # The display name of the role.
  • name: String!
  • # The display name of the role.
  • route: String!
  • # True if the role is active, false if it's been archived.
  • is_active: Boolean!
  • # True if the role is protected (only assignable by super-admins), false
  • # otherwise.
  • is_protected: Boolean!
  • # The list ordering of the role.
  • sort_order: Int!
  • # The description of the role's function.
  • description: String!
  • # True if this role applies to dashboard users, false otherwise.
  • is_dashboard_role: Boolean!
  • # True if this role applies to fieldworker users, false otherwise.
  • is_fieldworker_role: Boolean!
  • # True if the role restricts access, false otherwise.
  • is_restrictive: Boolean!
  • }

link Require by