For the complete documentation index, see llms.txt. This page is also available as Markdown.

GrantCategory

Represent a grant category. Grant categories are used to categorize access controls with action=Grant to allow structuring them better.

type GrantCategory {
  allowDuplicateNames: Boolean!
  allowedWhatItems: GrantCategoryAllowedWhatItems!
  allowedWhoItems: GrantCategoryAllowedWhoItems!
  canCreate: Boolean!
  createdAt: Time!
  defaultTypePerDataSource: [GrantCategoryTypeForDataSource!]
  description: String!
  descriptionMandatory: Boolean!
  globalExceptions: Boolean!
  icon: String!
  id: ID!
  isDefault: Boolean!
  isSystem: Boolean!
  locksOnCreate: [AccessControlLock!]
  modifiedAt: Time!
  multiDataSource: Boolean!
  name: String!
  namePlural: String!
  nameRegEx: String
  nameRegExMsg: String
  namingHintRegEx: String
  namingHintRegExMsg: String
}

Fields

allowDuplicateNames ● Boolean! non-null scalar

If true, it is possible to create multiple access controls with the same name in this category. Otherwise, this will be blocked.

allowedWhatItems ● GrantCategoryAllowedWhatItems! non-null object

Specifies which types can be put as WHAT items for access controls in this category.

allowedWhoItems ● GrantCategoryAllowedWhoItems! non-null object

Specifies which types can be put as WHO items for access controls in this category.

canCreate ● Boolean! non-null scalar

If true, access controls of this category can be created in the UI.

createdAt ● Time! non-null scalar

The time at which the grant category was created.

defaultTypePerDataSource ● [GrantCategoryTypeForDataSource!] list object

For each data source, a default access control type can be specified.

description ● String! non-null scalar

Description of the grant category.

descriptionMandatory ● Boolean! non-null scalar

If true, providing a description for access controls in this category is mandatory.

globalExceptions ● Boolean! non-null scalar

If true, no local exceptions for masks and filters are calculated for corresponding access controls. Regular global exceptions will be used instead.

icon ● String! non-null scalar

The icon to use in the user interface to identify grants of this category.

id ● ID! non-null scalar

A unique identifier for the grant category.

isDefault ● Boolean! non-null scalar

If true, new access controls will be created in this category as default and imported (external) access controls will also be in this category.

isSystem ● Boolean! non-null scalar

If true, this grant category is provisioned by the system and cannot be edited or removed.

locksOnCreate ● [AccessControlLock!] list enum

The locks that need to be set when an access control in this category is created.

modifiedAt ● Time! non-null scalar

The time at which the grant category was last modified.

multiDataSource ● Boolean! non-null scalar

If true, access controls in this category can be linked to multiple data sources. Otherwise, they will be limited to a single data source.

name ● String! non-null scalar

Display name for the grant category.

namePlural ● String! non-null scalar

The plural form of the display name for the grant category.

nameRegEx ● String scalar

If specified, the name of access controls in this category need to comply with the given regular expression.

nameRegExMsg ● String scalar

The message shown to the user when the name does not comply with the regular expression.

namingHintRegEx ● String scalar

If specified, the naming hint of access controls in this category need to comply with the given regular expression.

namingHintRegExMsg ● String scalar

The message shown to the user when the name does not comply with the regular expression.

Returned By

grantCategories query

Member Of

AccessControl object ● ReviewScheduleAccessControlTypes object

Implemented By

GrantCategoryResult union

Last updated

Was this helpful?