Magidoc

Role
Object

A role defines a set of permissions that can be assigned to users.

Fields

#

createdAt

UTCDateTime !
Non-null

The date and time this entity was created.

description

String

A description of what this role can do

id

GlobalId !
Non-null

A unique internal GlobalId for this entity.

isAdmin

Boolean !
Non-null

If true, this role is an admin role. Admin roles automatically receive permissions for new protected entities.

isCloudshelfInternalRole

Boolean !
Non-null

If true, this is a Cloudshelf internal role (for staff). Internal roles have organisation set to null.

isCustomRole

Boolean !
Non-null

If true, this is a custom role created by the organisation. Default/system roles have this set to false and cannot be edited or deleted.

name

String !
Non-null

The display name of the role (e.g., "Super Admin", "Content Manager")

organisation

Organisation

The organisation this role belongs to. Null for Cloudshelf internal staff roles.

permissions

[ RolePermission !]!
Non-null

The permissions granted to this role

sortOrder

Int

Sort order for display purposes. Lower numbers appear first. Custom roles have null and sort after system roles.

templateType

RoleTemplateType !
Non-null

Identifies which template this role was created from. System roles have a specific type, custom roles use CUSTOM.

updatedAt

UTCDateTime !
Non-null

The date and time this entity was last updated.

Usages

#

References

#

  • Field cloudshelfStaffRoles from Query