Skip to main content

Cookie control banner

Necessary Cookies
These cookies are necessary for this website to function correctly. They are set when you perform certain actions on the site, such as creating an account, logging in, changing your privacy preferences or submitting a form. You can block these cookies in your browser, but this will stop parts of the site from working properly.
Functional Cookies
These cookies allow the website to provide extra functionality and more personalised experiences. They may be set by us or by third party providers whose services we have added to our pages. If you choose not to allow these cookies, these services may not work correctly.
Analytical Cookies
These cookies record anonymous data on how visitors use our website to help us monitor how well our website works. This data includes how many people have looked at specific pages, how long visitors stay on the site, and what devices they use. We use this data to identify changes that we could make to improve your experience and make our website more efficient.
Marketing Cookies
We set some cookies so you are shown more relevant marketing content. These include cookies from third-party advertising networks to show you different adverts on their services if you have previously visited our site. If you choose not to allow these cookies, you may experience less relevant advertising on other sites.
Browse Documentation
HTTP - Management

Role

Created by Contensis product team, last modified by zengenti on 21 Jan 2021

Role definitions in the Management API contain permissions associated with content types and entries, and other resource types (e.g. webhook subscriptions, proxies, event streams), with users and groups assigned to those permissions.

Properties

NameData typeData formatDescriptionExample
nameobjectlocalized valueThe name of the role.
descriptionobjectlocalized valueThe description of the role.
enabledbooleanIf true then this role is enabled, otherwise false.
permissionsobject[...]Permissions associated with content types and entries.
permissions.entriesobject[...]An array of permissions for entries
permissions.entries.languagesstring[...]One or more languages to give permissions to. * denotes all languages.
permissions.entries.actionsstring[...]One or more actions to give permission to. denotes all actions. *{workflowStateName}.* denotes all permissions applicable to the given workflow state.
assignmentsobject[...]An array of assignments for entries
assignments.usersstring[...]Zero or more user names
assignments.groupsstring[...]Zero or more group names
assignments.apiKeysstring[...]Zero or more API key names

Example

JSON
{ "id": "34f503ca-fd44-4d47-b86a-c9d94c4d5d54", "projectId": "website", "name": { "en-GB": "Movie Editors" }, "description": { "en-GB": "Movie editors can edit movie entries, but not submit or approve them" }, "enabled": true, "permissions": { "entries": [ { "id": "movie", "languages": [ "en-GB" ], "actions": [ "sys.update", "draft.*", "awaitingApproval.revoke" ] } ], "assets": [{ "id": "*", "languages": ["*"], "actions": ["contensisEntryBasic.*"] } ], "webhookSubscriptions": { "actions": ["create", "view"] }, "proxies": { "actions": ["create", "update", "publish"] }, "eventStreams": { "actions": ["connect", "useCustomTemplates"] } }, "assignments": { "users": [ "f.haygood" ], "groups": [ "Movie Editors" ], "apiKeys": [ "Movie Import" ] } }