Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space MOBUD and version 3

The Role object contains the general details for an authorization role within the system. 

A role contains zero or more permissions and users. Each user assigned to the role will inherit its associated permissions. If a role's permission list is updated then every user associated with the role will also be updated. 

 

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:

Role Object Formats

Include Page
_Role Object Formats
_Role Object Formats

Role Object Properties

(info) Required properties are in bold.

PropertyTypeDescription
RoleIDstringIdentifies the unique role ID. This ID can not be changed once it is created.
Nameobject

This property contains a collection of key/value pairs that provide a localized short name of the role.

The sub-property name contains the language code and the value contains the localized role name for the language.

Descobject

This property contains a collection of key/value pairs that provide a localized description of the role.

The sub-property name contains the language code and the value contains the localized role description for the language.

PermissionsarrayContains a collection of zero or more permissions associated with this role.