Space Roles | Documentation

Group Space Roles

A role inside a space represents a collection of policies which determine what kind of access a user (or team) has within that space. See the complete documentation for space roles in the Content Management API for more details about how roles and policies can be managed via API.

Note: Space roles should not be confused with the organization role, which is an attribute of an organization membership.

Get all space roles in an organization

This endpoint returns a paginated list of all roles from all spaces across the organization.

Query Parameters

Name	Details	Description
`skip`, `limit`	-	Specify requested page of result set. See Pagination for more details.
`include`	Supported values: `sys.space`	Specify linked resources to include in response. See Including Related Resources for more details.

Response

1 {
2     "total": 2,
3     "limit": 25,
4     "skip": 0,
5     "sys": {
6         "type": "Array"
7     },
8     "items": [
9         {
10             "name": "Developer",
11             "description": "Allows reading Entries and managing API Keys",
12             "policies": [
13                 {
14                     "effect": "allow",
15                     "actions": [
16                         "read"
17                     ],
18                     "constraint": {
19                         "and": [
20                             {
21                                 "equals": [
22                                     {
23                                         "doc": "sys.type"
24                                     },
25                                     "Entry"
26                                 ]
27                             }
28                         ]
29                     }
30                 },
31                 {
32                     "effect": "allow",
33                     "actions": [
34                         "read"
35                     ],
36                     "constraint": {
37                         "and": [
38                             {
39                                 "equals": [
40                                     {
41                                         "doc": "sys.type"
42                                     },
43                                     "Asset"
44                                 ]
45                             }
46                         ]
47                     }
48                 }
49             ],
50             "permissions": {
51                 "ContentModel": [
52                     "read"
53                 ],
54                 "Settings": [],
55                 "ContentDelivery": "all"
56             },
57             "sys": {
58                 "type": "Role",
59                 "id": "4hD58EyqKCOyHwo2nTzojk",
60                 "version": 0,
61                 "space": {
62                     "sys": {
63                         "type": "Link",
64                         "linkType": "Space",
65                         "id": "jn066pnp3hgr"
66                     }
67                 },
68                 "createdBy": {
69                     "sys": {
70                         "type": "Link",
71                         "linkType": "User",
72                         "id": "3JE87mfI5hDuAaq0hpbbEh"
73                     }
74                 },
75                 "createdAt": "2017-11-09T09:16:10Z",
76                 "updatedBy": {
77                     "sys": {
78                         "type": "Link",
79                         "linkType": "User",
80                         "id": "3JE87mfI5hDuAaq0hpbbEh"
81                     }
82                 },
83                 "updatedAt": "2017-11-09T09:16:10Z"
84             }
85         },
86         {
87             "name": "Editor",
88             "description": "Allows editing, publishing and archiving of content",
89             "policies": [
90                 {
91                     "effect": "allow",
92                     "actions": "all",
93                     "constraint": {
94                         "and": [
95                             {
96                                 "equals": [
97                                     {
98                                         "doc": "sys.type"
99                                     },
100                                     "Entry"
101                                 ]
102                             }
103                         ]
104                     }
105                 },
106                 {
107                     "effect": "allow",
108                     "actions": "all",
109                     "constraint": {
110                         "and": [
111                             {
112                                 "equals": [
113                                     {
114                                         "doc": "sys.type"
115                                     },
116                                     "Asset"
117                                 ]
118                             }
119                         ]
120                     }
121                 }
122             ],
123             "permissions": {
124                 "ContentModel": [
125                     "read"
126                 ],
127                 "Settings": [],
128                 "ContentDelivery": []
129             },
130             "sys": {
131                 "type": "Role",
132                 "id": "4hDOJRz3lT01Jv6WVogTfE",
133                 "version": 0,
134                 "space": {
135                     "sys": {
136                         "type": "Link",
137                         "linkType": "Space",
138                         "id": "jn066pnp3hgr"
139                     }
140                 },
141                 "createdBy": {
142                     "sys": {
143                         "type": "Link",
144                         "linkType": "User",
145                         "id": "3JE87mfI5hDuAaq0hpbbEh"
146                     }
147                 },
148                 "createdAt": "2017-11-09T09:16:10Z",
149                 "updatedBy": {
150                     "sys": {
151                         "type": "Link",
152                         "linkType": "User",
153                         "id": "3JE87mfI5hDuAaq0hpbbEh"
154                     }
155                 },
156                 "updatedAt": "2017-11-09T09:16:10Z"
157             }
158         }
159     ]
160 }