Get permissions for a resource
Log in to add to favouritesPage last updated 04 December 2020
Get permissions for a resource
Gets a permission set for the requested user and resource. Requesting a permission set returns the positive permission values assigned to the user for all roles the user is assigned to (either directly or via a group).
GET /api/management/projects/{projectId}/security/permissions/{resourceType}/{resourceId?}?userId={userId}&language={language}
Parameters
| Name | Parameter type | Type | Format | Description |
|---|---|---|---|---|
| projectId | path | string | The project identifier, e.g. "movieDb". Found in the project overview screen of the management console. | |
| resourceType | path | string | The type of resource to retrieve permissions for. Contenttypes or entries. | |
| resourceId | path | GUID | Optional id of the resource to retrieve permissions for. | |
| userId | query | string | The id of the user to retrieve permissions for. | |
| language | query | string | LanguageCode | The optional language code to retrieve permissions for. |
Example request
GET: /api/management/projects/movieDb/security/permissions/entries/a65a9d9d-ee64-4c25-a80c-ab5aee00fb9d?userId=a.userResponse message
| HTTP status code | Reason | Response model |
|---|---|---|
| 200 | Success | Array of actions available |
| 404 | NotFound | Error |
| 500 | InternalServerError | Error |
Example response
{
"actions": ["sysCreate", "draft.sysDelete", "draft.submit", "draft.sysUpdate", "submitted.revoke"]
}Validations
Project does not exist
Roles are project specific. If you attempt to get a role in a project which does not exist you will get the following response.
{
"logId": "00000000-0000-0000-0000-000000000000",
"message": "There are validation errors getting the role",
"data": [
{
"field": "projectId",
"message": "The project does not exist"
}
],
"type": "Validation"
}