Permission

Permission
Permission

This data object type provides assignment of some role access to a principal on a specific entity.

A ManagedEntity is limited to one permission per principal.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "principal": "string",
    "group": false,
    "roleId": 0,
    "propagate": false
}
entity
Optional

Managed entity the permission is defined on.

Left unset when calling setPermissions or resetPermissions, but present for the results of permission queries.

string
principal
Required

User or group receiving access in the form of "login" for local or "DOMAIN\login" for users in a Windows domain.

boolean
group
Required

Whether principal refers to a user or a group.

True for a group and false for a user.

integer As int32 As int32
roleId
Required

Reference to the role providing the access.

boolean
propagate
Required

Whether or not this permission propagates down the hierarchy to sub-entities.

Property Of