Content Management API > Role

List all roles

Lists every role defined on the project, including the built-in factory roles (e.g. Admin, Editor) and any custom ones.

Each entry includes both the directly-declared attributes and the inheritance-aware meta.final_permissions (see the Retrieve a role endpoint for the difference).

Returns

Returns an array of resource objects of type role

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const roles = await client.roles.list();
7

8
  for (const role of roles) {
9
    // Check the 'Returned output' tab for the result ☝️
10
    console.log(role);
11
  }
12
}
13

14
run();

1
{
2
  id: "34",
3
  name: "Editor",
4
  can_edit_site: true,
5
  can_edit_favicon: true,
6
  can_edit_schema: true,
7
  can_manage_menu: true,
8
  can_manage_users: true,
9
  can_manage_shared_filters: true,
10
  can_manage_search_indexes: true,
11
  can_manage_upload_collections: true,
12
  can_manage_environments: true,
13
  can_manage_webhooks: true,
14
  environments_access: "primary_only",
15
  can_manage_sso: true,
16
  can_access_audit_log: true,
17
  can_manage_workflows: true,
18
  can_edit_environment: true,
19
  can_promote_environments: true,
20
  can_manage_build_triggers: true,
21
  can_manage_access_tokens: true,
22
  can_perform_site_search: true,
23
  can_access_build_events_log: true,
24
  can_access_search_index_events_log: true,
25
  positive_item_type_permissions: [
26
    {
27
      action: "all",
28
      environment: "main",
29
      on_creator: "anyone",
30
      localization_scope: "all",
31
    },
32
    { action: "read", environment: "main", on_creator: "anyone" },
33
    { action: "create", environment: "main", localization_scope: "all" },
34
    {
35
      action: "update",
36
      environment: "main",
37
      on_creator: "anyone",
38
      localization_scope: "all",
39
    },
40
    { action: "duplicate", environment: "main" },
41
    { action: "delete", environment: "main", on_creator: "anyone" },
42
    { action: "move_to_stage", environment: "main", on_creator: "anyone" },
43
  ],
44
  negative_item_type_permissions: [
45
    {
46
      action: "all",
47
      environment: "main",
48
      on_creator: "anyone",
49
      localization_scope: "all",
50
    },
51
    { action: "read", environment: "main", on_creator: "anyone" },
52
    { action: "create", environment: "main", localization_scope: "all" },
53
    {
54
      action: "update",
55
      environment: "main",
56
      on_creator: "anyone",
57
      localization_scope: "all",
58
    },
59
    { action: "duplicate", environment: "main" },
60
    { action: "delete", environment: "main", on_creator: "anyone" },
61
    { action: "move_to_stage", environment: "main", on_creator: "anyone" },
62
  ],
63
  positive_upload_permissions: [
64
    {
65
      action: "all",
66
      environment: "main",
67
      on_creator: "anyone",
68
      localization_scope: "all",
69
    },
70
    {
71
      action: "update",
72
      environment: "main",
73
      on_creator: "anyone",
74
      localization_scope: "all",
75
    },
76
    { action: "create", environment: "main" },
77
    { action: "read", environment: "main", on_creator: "anyone" },
78
    { action: "move", environment: "main", on_creator: "anyone" },
79
  ],
80
  negative_upload_permissions: [
81
    {
82
      action: "all",
83
      environment: "main",
84
      on_creator: "anyone",
85
      localization_scope: "all",
86
    },
87
    {
88
      action: "update",
89
      environment: "main",
90
      on_creator: "anyone",
91
      localization_scope: "all",
92
    },
93
    { action: "create", environment: "main" },
94
    { action: "read", environment: "main", on_creator: "anyone" },
95
    { action: "move", environment: "main", on_creator: "anyone" },
96
  ],
97
  positive_build_trigger_permissions: [{}],
98
  negative_build_trigger_permissions: [{}],
99
  positive_search_index_permissions: [{}],
100
  negative_search_index_permissions: [{}],
101
  meta: {
102
    final_permissions: {
103
      can_edit_site: true,
104
      can_edit_favicon: true,
105
      can_edit_schema: true,
106
      can_manage_menu: true,
107
      can_manage_users: true,
108
      can_manage_environments: true,
109
      can_manage_webhooks: true,
110
      environments_access: "primary_only",
111
      can_manage_sso: true,
112
      can_access_audit_log: true,
113
      can_manage_workflows: true,
114
      can_edit_environment: true,
115
      can_promote_environments: true,
116
      can_manage_shared_filters: true,
117
      can_manage_search_indexes: true,
118
      can_manage_build_triggers: true,
119
      can_manage_upload_collections: true,
120
      can_manage_access_tokens: true,
121
      can_perform_site_search: true,
122
      can_access_build_events_log: true,
123
      can_access_search_index_events_log: true,
124
      positive_item_type_permissions: [
125
        {
126
          action: "all",
127
          environment: "main",
128
          on_creator: "anyone",
129
          localization_scope: "all",
130
        },
131
        { action: "read", environment: "main", on_creator: "anyone" },
132
        { action: "create", environment: "main", localization_scope: "all" },
133
        {
134
          action: "update",
135
          environment: "main",
136
          on_creator: "anyone",
137
          localization_scope: "all",
138
        },
139
        { action: "duplicate", environment: "main" },
140
        { action: "delete", environment: "main", on_creator: "anyone" },
141
        { action: "move_to_stage", environment: "main", on_creator: "anyone" },
142
      ],
143
      negative_item_type_permissions: [
144
        {
145
          action: "all",
146
          environment: "main",
147
          on_creator: "anyone",
148
          localization_scope: "all",
149
        },
150
        { action: "read", environment: "main", on_creator: "anyone" },
151
        { action: "create", environment: "main", localization_scope: "all" },
152
        {
153
          action: "update",
154
          environment: "main",
155
          on_creator: "anyone",
156
          localization_scope: "all",
157
        },
158
        { action: "duplicate", environment: "main" },
159
        { action: "delete", environment: "main", on_creator: "anyone" },
160
        { action: "move_to_stage", environment: "main", on_creator: "anyone" },
161
      ],
162
      positive_upload_permissions: [
163
        {
164
          action: "all",
165
          environment: "main",
166
          on_creator: "anyone",
167
          localization_scope: "all",
168
        },
169
        {
170
          action: "update",
171
          environment: "main",
172
          on_creator: "anyone",
173
          localization_scope: "all",
174
        },
175
        { action: "create", environment: "main" },
176
        { action: "read", environment: "main", on_creator: "anyone" },
177
        { action: "move", environment: "main", on_creator: "anyone" },
178
      ],
179
      negative_upload_permissions: [
180
        {
181
          action: "all",
182
          environment: "main",
183
          on_creator: "anyone",
184
          localization_scope: "all",
185
        },
186
        {
187
          action: "update",
188
          environment: "main",
189
          on_creator: "anyone",
190
          localization_scope: "all",
191
        },
192
        { action: "create", environment: "main" },
193
        { action: "read", environment: "main", on_creator: "anyone" },
194
        { action: "move", environment: "main", on_creator: "anyone" },
195
      ],
196
      positive_build_trigger_permissions: [{}],
197
      negative_build_trigger_permissions: [{}],
198
      positive_search_index_permissions: [{}],
199
      negative_search_index_permissions: [{}],
200
    },
201
  },
202
  inherits_permissions_from: [{ type: "role", id: "34" }],
203
}