RoleData

The role object contains meta-data for the role.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

roleId

The role's system ID

 -

string

uuid

roleName

The role's name

Y

string

isHidden

Flag to indicate if the role is hidden

 -

boolean

tenantId

The roles's tenant (ID)

Y

string

uuid

description

The Role description

 -

string

*Required elements are only used for API parameters

Usages
  • /API2/access/createRole
  • /API2/access/createRoles
  • /API2/access/getAllNonPrivateRolesByTenant
  • /API2/access/getAllRolesByProfileId
  • /API2/access/getRoleById
  • /API2/content/getContentItemSecurityRoles
  • /API3/access/getPublicRolesByTenant
  • /API3/access/getRoleById
  • /API3/access/getRolesbyProfile
  • /API3/content/getItemRoles