Skip to main content

Role Schema

Data structure for Role objects.

Fields​

FieldTypeRequiredDescriptionNotes
idlongNo--
modified_timeintegerNo-API field: modified_time
creation_timeintegerNo-API field: creation_time
modified_bylongNo-API field: modified_by
namestringYes--
microtenant_idlongNo-API field: microtenant_id
microtenant_namestringNo-API field: microtenant_name
descriptionstringNo--
bypass_remote_assistance_checkbooleanNo-API field: bypass_remote_assistance_check
permissionsClassPermissionWrapperCollectionNo--
custom_rolebooleanNo-API field: custom_role
system_rolebooleanNo-API field: system_role
restricted_rolebooleanNo-API field: restricted_role
class_permission_groupsACLClassPermissionGroupWrapperCollectionNo-API field: class_permission_groups
userslongNo--
api_keyslongNo-API field: api_keys
new_audit_messagestringNo-API field: new_audit_message
old_audit_messagestringNo-API field: old_audit_message
name_without_trimstringNo-API field: name_without_trim
hidden_UIbooleanNo-API field: hidden_UI

Example​

{
"id": 123,
"modified_time": 123,
"creation_time": 123,
"modified_by": 123,
"name": "string",
"microtenant_id": 123,
"microtenant_name": "string",
"description": "string"
}
// ... more fields