Roles
A named access role for spaces, folders and documents, such as "Metric analyst". The role is built on one of three templates (reader, writer, admin) that decide its permissions; free-form permissions are not accepted. Give roles to users and groups with role_refs of tree_entity_roles; reader, writer and admin are the names of the built-in roles, so a role cannot have one of them as its external_id. A role only applies to the records of the package and never changes company-wide rights. A package with groups or roles of your own can be imported only by a user with the Members management permission, and only if the tariff includes groups.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "roles". An entity can have any number of files. See Bundle format.
[
{
"resource": "roles",
"path": "resources/roles.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it.Constraints: 1–512 characters. |
name | string | Yes | Name of the role, for example Metric analyst. Up to 128 characters.Constraints: 1–128 characters. |
template | enum | Yes | The built-in role whose permissions this role gets: reader, writer or admin.Constraints: one of reader, writer, admin. |
References
Referenced by
- Tree entity roles:
role_refs
Show on the entity map
Example
A record of this entity:
{
"external_id": "ter-analyst",
"name": "Metric analyst",
"template": "writer"
}Rules
- external_id is not reader, writer or admin, the names of the built-in roles.
Related entities
Tree entity roles
Check after the import
After the import, the records of this entity can be checked on Tree entity roles › Get list of tree entity roles.
JSON Schema
roles.json
