List All Permissions on an Editorial Role
get
/content/management/api/v1.1/editorialRoles/{roleId}/permissions
List all permissions on a custom editorial role.
Request
Path Parameters
-
roleId: string
id of the custom editorial role.
Query Parameters
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
orderBy(optional): string
This parameter is used to control order of results. The value of this query parameter follows the format of fieldName:[asc/desc]. asc stands for ascending order desc stands for descending order, default order is asc.The only fields allowed in the field name are fullName and type.Default Value:
fullName:asc
-
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : ResourcePermissions
Type:
object
ResourcePermissions
Show Source
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object ResourcePermission
ResourcePermission
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : ResourcePermission
Type:
object
ResourcePermission
Show Source
-
email(optional):
string
email of the user.
-
fullName(optional):
string
full name of the user.
-
groupType(optional):
string
Allowed Values:
[ "CEC", "IDP" ]
type of the group. -
id(optional):
string
userId login name of the user.
-
links(optional):
array links
Read Only:
true
Links -
role(optional):
object PermissionRole
PermissionRole
-
roleName(optional):
string
name of the role on the resource. Deprecated. Replaced by the 'role' property.
-
type(optional):
string
Allowed Values:
[ "user", "group" ]
type of the user.
Nested Schema : links
Type:
array
Read Only:
true
Links
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : PermissionRole
Type:
object
PermissionRole
Show Source
-
description(optional):
string
Description of the role. Only applicable to custom editorial or publishing roles.
-
id(optional):
string
ID of the role. Only applicable to permission sets and custom editorial or publishing roles.
-
links(optional):
array links
Links
-
name(optional):
string
Name of the role.
-
type(optional):
string
Allowed Values:
[ "standard", "custom", "editorial", "publishing" ]
Type of the role. Values are 'standard', 'custom', 'editorial', and 'publishing'.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
500 Response
Internal server error.
Examples
The following example shows how to list editorial role permissions by submitting a GET request using cURL.
curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/editorialRoles/{roleId}/permissions'
Example
/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions
Lists an editorial role permissions. Here 7A58B07965C54543B7C0517562DDC313 is Id of the editorial role.
Response Body
{ "hasMore": false, "offset": 0, "count": 2, "limit": 2, "items": [ { "id": "cecuserLoginIdName1", "roleName": "manager", "type": "user", "email": "email1", "fullName": "cecuser1" }, { "id": "cecgroupLoginIdName2", "roleName": "manager", "type": "group", "email": "email2", "fullName": "cecgroup2" } ], "links": [ { "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions", "rel": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions", "rel": "describedby", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions?offset=0", "rel": "first", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions?offset=0", "rel": "last", "method": "GET", "mediaType": "application/json" } ] }