OBJECT

CustomEntityMasterRight

Rights of a user role to one custom entity: screen access, record access level and the actions its users may take.

link GraphQL Schema definition

  • type CustomEntityMasterRight {
  • # API name of the custom entity these settings apply to.
  • entityApiName: String!
  • # Shows the screen of the custom entity to users with this role. Which records
  • # they can see and edit is set by accessLevel.
  • navigationAccess: Boolean!
  • # Level of access to records of the custom entity for users with this role, from
  • # NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the
  • # records the role can see.
  • accessLevel: AccessLevelEntityEnum!
  • # Which records of the custom entity users with this role can see besides those
  • # they own or that are shared with them: no others (Owned), those of their sales
  • # units (Current and its variants) or all (All).
  • accessDirection: AccessDirectionEnum!
  • # Allows users with this role to own private records of the custom entity, which
  • # are visible only to their owner.
  • accessPrivate: Boolean!
  • # Allows users with this role to delete records of the custom entity they can
  • # edit.
  • accessDelete: Boolean!
  • # Whether users with this role can work with all types of the custom entity (All)
  • # or only with those in allowedEntityTypeIds (Selected).
  • accessEntityTypes: AccessEntityTypesEnum!
  • # Types of the custom entity this user role can use. Effective only when
  • # accessEntityTypes is set to Selected.
  • allowedEntityTypeIds: [ID!]!
  • # Default screen profile (saved screen view) of the custom entity screen for users
  • # with this role.
  • defaultProfileId: ID!
  • # Allows users with this role to create copies of existing records of the custom
  • # entity.
  • accessCopy: Boolean!
  • # Allows users with this role to create new tags for records of the custom entity.
  • accessTagCreate: Boolean!
  • }