PermissionData

PermissionData
PermissionData

Details about a permission.

JSON Example
{
    "entity": "string",
    "principal": "string",
    "isGroup": false,
    "role_name": "string",
    "role_id": 0,
    "defined_on_entity": "string",
    "propagate": false,
    "group": false
}
string
entity
Required

The entity the permission is defined on.

string
principal
Required

User or group receiving access in the form of "login".

boolean
isGroup
Optional

isGroup

string
role_name
Required

The label for the role in a string format.

integer As int32 As int32
role_id
Optional

The id of the role defined at the VC.

string
defined_on_entity
Required

Indicates whether the permission is defined on this object or it is inherited from a parent and whether this permission propagates down the hierarchy to sub-entities.

boolean
propagate
Optional

Defines whether the role is propagated to the children of the entity.

boolean
group
Optional

Whether principal refers to a user or a group. True for a group and false for a user.