Permission

A permission.

type Permission {
  action: String!
  createdAt: DateTime!
  description: String
  direct: Boolean
  fromRole: String
  id: ID!
  isActive: Boolean!
  isSystem: Boolean!
  metadata: JSON
  module: String!
  name: String!
  resource: String!
  updatedAt: DateTime!
}

Fields

Permission.action ● String! non-null scalar

What it lets someone do.

Permission.createdAt ● DateTime! non-null scalar

When the record was created.

Permission.description ● String scalar

What the permission allows.

Permission.direct ● Boolean scalar

True when it was granted directly to the user and can be removed. Set only when listing a user's permissions.

Permission.fromRole ● String scalar

The role the permission comes from, when it is inherited and read-only.

Permission.id ● ID! non-null scalar

The unique ID of this record.

Permission.isActive ● Boolean! non-null scalar

Whether the record is active.

Permission.isSystem ● Boolean! non-null scalar

True when the permission is built in.

Permission.metadata ● JSON scalar

Additional data attached to the record, as JSON.

Permission.module ● String! non-null scalar

The module the permission is in.

Permission.name ● String! non-null scalar

The name of the permission.

Permission.resource ● String! non-null scalar

The kind of record it is on.

Permission.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Returned By

myPermissions query ● permission query ● permissions query ● rolePermissions query ● userPermissions query

Member Of

PermissionResource object ● Role object ● User object