Role

A role: a named set of permissions that can be given to users.

type Role {
  createdAt: DateTime!
  deletedAt: DateTime
  deletedBy: String
  description: String
  displayName: String!
  enteredBy: String!
  id: ID!
  isActive: Boolean!
  isSystem: Boolean!
  metadata: String
  name: String!
  organizationId: String!
  permissionCount: Int
  permissions: [Permission!]
  priority: Int!
  updatedAt: DateTime!
  updatedBy: String!
  userCount: Int
  users: [User!]
}

Fields

Role.createdAt ● DateTime! non-null scalar

When the record was created.

Role.deletedAt ● DateTime scalar

When the record was deleted. Empty while the record is live.

Role.deletedBy ● String scalar

The ID of the user who deleted the record.

Role.description ● String scalar

What the role is for.

Role.displayName ● String! non-null scalar

The name to show for the role.

Role.enteredBy ● String! non-null scalar

The ID of the user who created the record.

Role.id ● ID! non-null scalar

The unique ID of this record.

Role.isActive ● Boolean! non-null scalar

Whether the record is active.

Role.isSystem ● Boolean! non-null scalar

True when the role is built in.

Role.metadata ● String scalar

Extra information about the role, as JSON text.

Role.name ● String! non-null scalar

The name of the role.

Role.organizationId ● String! non-null scalar

The ID of the organization the record belongs to.

Role.permissionCount ● Int scalar

How many permissions the role has.

Role.permissions ● [Permission!] list object

The permissions of the role.

Role.priority ● Int! non-null scalar

The rank of the role.

Role.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Role.updatedBy ● String! non-null scalar

The ID of the user who last changed the record.

Role.userCount ● Int scalar

How many users are in the role.

Role.users ● [User!] list object

The users in the role.

Returned By

cloneRole mutation ● createRole mutation ● restoreRole mutation ● role query ● roles query ● updateRole mutation ● userRoles query

Member Of

User object