OBJECT

FieldPermissionEntity

Access a user role has to a custom field: full access, read-only or hidden.

link GraphQL Schema definition

  • type FieldPermissionEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # True when the record has unpublished draft changes, including pending
  • # translation changes, that can be published.
  • hasDraft: Boolean
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Custom field this permission applies to.
  • field: FieldEntity
  • # User role granted (or restricted) on the field.
  • masterRight: MasterRightEntity
  • # Id of the custom field.
  • fieldId: ID!
  • # Id of the user role.
  • masterRightId: ID!
  • # Access the user role gets to the custom field: full access (view and edit),
  • # read-only, or hidden.
  • permissionLevel: AccessLevelFieldEnum
  • # True when the permission override is published; false while it exists only as an
  • # unpublished draft.
  • isPublished: Boolean
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }