Skip to main content
Browse Documentation
HTTP - Management

Role

Created by Contensis product team, last modified by zengenti on 02 Nov 2020

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

Properties

NameData typeData formatDescription
idstringGUIDThe role identifier as a 128 bit GUID.
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.idstringGUIDThe entry identifier as a 128 bit GUID.
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.
permissions.assetsobject[...]An array of permissions for assets
permissions.assets.idstringGUIDThe asset identifier as a 128 bit GUID.
permissions.assets.languagesstring[...]One or more languages to give permissions to. * denotes all languages.
permissions.assets.actionsstring[...]One or more actions to give permission to. denotes all actions. *{workflowStateName}.* denotes all permissions applicable to the given workflow state.
permissions.webhookSubscriptionobjectPermissions for webhook subscriptions
permissions.webhookSubscription.actionsstring[...]One or more actions to give permission for webhook subscriptions. The possible values are: create, update, delete, view.
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

{
    "id": "34f503ca-fd44-4d47-b86a-c9d94c4d5d54",
    "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.*"]
            }
        ],
        "webhookSubscription": {
            "actions": [ "create", "view" ]
        }    },
    "assignments": {
        "users": [
            "f.haygood"
        ],
        "groups": [
            "Movie Editors"
        ],
        "apiKeys": [
            "Movie Import"
        ]
    }
}