Role

Properties

Name	Type	Format	Description	Example
id	string	GUID	The role identifier as a 128 bit GUID.
projectId	string	-	The project identifier found in the project overview screen of the management console.	movieDb
name	object	localized value	The name of the role.
description	object	localized value	The description of the role.
enabled	boolean	-	If true then this role is enabled, otherwise false.
permissions	object[...]	-	Permissions associated with content types and entries.
permissions.entries	object[...]	-	An array of permissions for entries
permissions.entries.id	string	GUID	The entry identifier as a 128 bit GUID.
permissions.entries.languages	string[...]	-	One or more languages to give permissions to. * denotes all languages.
permissions.entries.actions	string[...]	-	One or more actions to give permission to. denotes all actions. {workflowStateName}. denotes all permissions applicable to the given workflow state.
permissions.assets	object[...]	-	An array of permissions for assets
permissions.assets.id	string	GUID	The asset identifier as a 128 bit GUID.
permissions.assets.languages	string[...]	-	One or more languages to give permissions to. * denotes all languages.
permissions.assets.actions	string[...]	-	One or more actions to give permission to. denotes all actions. {workflowStateName}. denotes all permissions applicable to the given workflow state.
permissions.webhookSubscriptions	object	-	The permissions for webhook subscriptions
permissions.webhookSubscriptions.actions	string[...]	-	One or more actions to give permission for webhook subscriptions. The possible values are: create, update, delete, view, useCustomTemplates..
permissions.proxies	object	-	The permissions for proxies
permissions.proxies.actions	string[...]	-	One or more actions to give permission for proxies. The possible values are: create, update, publish, delete, view.
permissions.eventStreams	object	-	The permissions for event streams
permissions.eventStreams.actions	string[...]	-	One or more actions to give permission for event streams. The possible values are: connect, useCustomTemplates.
assignments	object[...]	-	An array of assignments for entries
assignments.users	string[...]	-	Zero or more user names
assignments.groups	string[...]	-	Zero or more group names
assignments.apiKeys	string[...]	-	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"
        ]
    }
}

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"
        ]
    }
}

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"
        ]
    }
}

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.

New support request