Skip to main content
Browse Documentation

Node

Created by Scott Yearsley, last modified by Simon Horan on 22 Jan 2020

Role definitions in the Management API contain permissions associated with entries and assets, with users, groups and API keys assigned to those permissions.

Properties

Name Type Description
Id Guid The role identifier
Name string The role name
Description string An optional description for the role to explain it's purpose
Enabled bool A flag to enable and disable the effect of the role
Permissions RolePermissions The permissions assigned to the role to allow users and groups to perform certain actions
Assignment RoleAssignments The users, groups and API keys assigned to the role

RolePermissions

Name Type Description
Entries List<EntryPermission> A list of permissions for entries.
Assets List<EntryPermission> A list of permissions for assets.

RoleAssignments

Name Type Description
Users List<string> The usernames of the users assigned to the role
Groups List<string> The names of the groups assigned to the role
ApiKeys List<string> The names of the API keys assigned to the role

EntryPermission

Name Type Description
Users List<string> The usernames of the users assigned to the role
Groups List<string> The names of the groups assigned to the role
ApiKeys List<string> The names of the API keys assigned to the role

Methods

Method Returns Description
Save() void Saves changes made to the node instance.
SaveAsync() Task Saves changes made to the node instance asynchronously.
Delete() void Deletes the node instance.
DeleteAsync() Task Deletes the node instance instance asynchronously.