Sorry, no results found for "".

Show examples in:

Javascript HTTP

Endpoint info

Body parameters

Returns

Available examples

Basic example

Content Management API > Role

Update a role

Body parameters

name string Optional

The name of the role

Example:

"Editor"

can_edit_favicon boolean Optional

Can edit favicon, global SEO settings and no-index policy

can_edit_site boolean Optional

Can change project global properties

can_edit_schema boolean Optional

Can create/edit models and plugins

can_manage_menu boolean Optional

Can customize content navigation bar

can_edit_environment boolean Optional

Can change locales, timezone and UI theme

can_promote_environments boolean Optional

Can promote environments to primary and manage maintenance mode

environments_access enum Optional

Specifies the environments the user can access

Example:

"primary_only"

all Optional

Can access all environments

primary_only Optional

Can access primary environment only

sandbox_only Optional

Can access sandbox environments only

can_manage_users boolean Optional

Can create/edit roles and invite/remove collaborators

can_manage_shared_filters boolean Optional

Can create/edit shared filters (both for models and the media area)

can_manage_upload_collections boolean Optional

Can create/edit upload collections

can_manage_build_triggers boolean Optional

Can create/edit Build triggers

can_manage_webhooks boolean Optional

Can create/edit webhooks

can_manage_environments boolean Optional

Can create/delete sandbox environments and promote them to primary environment

can_manage_sso boolean Optional

Can manage Single Sign-On settings

can_access_audit_log boolean Optional

Can access Audit Log

can_manage_workflows boolean Optional

Can create/edit workflows

can_manage_access_tokens boolean Optional

Can manage API tokens

can_perform_site_search boolean Optional

Can perform Site Search API calls

can_access_build_events_log boolean Optional

Can access the build events log

positive_item_type_permissions Optional

Allowed actions on a model (or all) for a role

Type: Array<object>

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

duplicate Optional

delete Optional

publish Optional

edit_creator Optional

take_over Optional

move_to_stage Optional

item_type undefined Optional

workflow undefined Optional

on_stage null, string Optional

to_stage null, string Optional

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Content under a specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

negative_item_type_permissions Optional

Prohibited actions on a model (or all) for a role

Type: Array<object>

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

duplicate Optional

delete Optional

publish Optional

edit_creator Optional

take_over Optional

move_to_stage Optional

item_type undefined Optional

workflow undefined Optional

on_stage null, string Optional

to_stage null, string Optional

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Content under a specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

positive_upload_permissions Optional

Allowed actions on a model (or all) for a role

Type: Array<object>

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

delete Optional

edit_creator Optional

replace_asset Optional

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Localized content in specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

negative_upload_permissions Optional

Prohibited actions on a model (or all) for a role

Type: Array<object>

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

delete Optional

edit_creator Optional

replace_asset Optional

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Localized content in specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

positive_build_trigger_permissions Optional

Allowed build triggers for a role

Type: Array<object>

build_trigger undefined Optional

negative_build_trigger_permissions Optional

Prohibited build triggers for a role

Type: Array<object>

build_trigger undefined Optional

meta.final_permissions object Optional

The final set of permissions considering also inherited roles

can_edit_site boolean Required

Can change project global properties

can_edit_favicon boolean Required

Can edit favicon, global SEO settings and no-index policy

can_edit_schema boolean Required

Can create/edit models and plugins

can_manage_menu boolean Required

Can customize content navigation bar

can_manage_users boolean Required

Can create/edit roles and invite/remove collaborators

can_manage_environments boolean Required

Can create/delete sandbox environments and promote them to primary environment

can_manage_webhooks boolean Required

Can create/edit webhooks

environments_access enum Required

Specifies the environments the user can access

Example:

"primary_only"

all Optional

Can access all environments

primary_only Optional

Can access primary environment only

sandbox_only Optional

Can access sandbox environments only

can_manage_sso boolean Required

Can manage Single Sign-On settings

can_access_audit_log boolean Required

Can access Audit Log

can_manage_workflows boolean Required

Can create/edit workflows

can_edit_environment boolean Required

Can change locales, timezone and UI theme

can_promote_environments boolean Required

Can promote environments to primary and manage maintenance mode

can_manage_shared_filters boolean Required

Can create/edit shared filters (both for models and the media area)

can_manage_build_triggers boolean Required

Can create/edit Build triggers

can_manage_upload_collections boolean Required

Can create/edit upload collections

can_manage_access_tokens boolean Required

Can manage API tokens

can_perform_site_search boolean Required

Can perform Site Search API calls

can_access_build_events_log boolean Required

Can access the build events log

positive_item_type_permissions Required

Allowed actions on a model (or all) for a role

Type: Array<object>

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

duplicate Optional

delete Optional

publish Optional

edit_creator Optional

take_over Optional

move_to_stage Optional

item_type undefined Optional

workflow undefined Optional

on_stage null, string Optional

to_stage null, string Optional

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Content under a specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

negative_item_type_permissions Required

Prohibited actions on a model (or all) for a role

Type: Array<object>

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

duplicate Optional

delete Optional

publish Optional

edit_creator Optional

take_over Optional

move_to_stage Optional

item_type undefined Optional

workflow undefined Optional

on_stage null, string Optional

to_stage null, string Optional

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Content under a specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

positive_upload_permissions Required

Allowed actions on a model (or all) for a role

Type: Array<object>

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

delete Optional

edit_creator Optional

replace_asset Optional

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Localized content in specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

negative_upload_permissions Required

Prohibited actions on a model (or all) for a role

Type: Array<object>

action enum Required

Permitted action

Example:

"all"

all Optional

read Optional

update Optional

create Optional

delete Optional

edit_creator Optional

replace_asset Optional

environment string Required

ID of environment. Can only contain lowercase letters, numbers and dashes

Example:

"main"

on_creator enum, null Optional

Permitted creator

Example:

"self"

anyone Optional

Created by anyone

self Optional

Created by the user itself

role Optional

Created by a user with the same role

localization_scope enum, null Optional

Permitted content scope

Example:

"all"

all Optional

Any content (localized/unlocalized)

localized Optional

Localized content in specific locale (locale must be defined)

not_localized Optional

Non-localized content

locale string, null Optional

Permitted localized content in this locale. Required when localization_scope is localized

Example:

"en"

positive_build_trigger_permissions Required

Allowed build triggers for a role

Type: Array<object>

build_trigger undefined Optional

negative_build_trigger_permissions Required

Prohibited build triggers for a role

Type: Array<object>

build_trigger undefined Optional

inherits_permissions_from Optional

The roles from which this role inherits permissions

Type: Array<ResourceLinkage<"role">>

Returns

Returns a resource object 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 roleId = "34";
7

8
  const role = await client.roles.update(roleId, { id: "34" });
9

10
  // Check the 'Returned output' tab for the result ☝️
11
  console.log(role);
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_upload_collections: true,
11
  can_manage_environments: true,
12
  can_manage_webhooks: true,
13
  environments_access: "primary_only",
14
  can_manage_sso: true,
15
  can_access_audit_log: true,
16
  can_manage_workflows: true,
17
  can_edit_environment: true,
18
  can_promote_environments: true,
19
  can_manage_build_triggers: true,
20
  can_manage_access_tokens: true,
21
  can_perform_site_search: true,
22
  can_access_build_events_log: true,
23
  positive_item_type_permissions: [{ environment: "main", action: "all" }],
24
  negative_item_type_permissions: [{ environment: "main", action: "all" }],
25
  positive_upload_permissions: [{ action: "all", environment: "main" }],
26
  negative_upload_permissions: [{ action: "all", environment: "main" }],
27
  positive_build_trigger_permissions: [{}],
28
  negative_build_trigger_permissions: [{}],
29
  meta: {
30
    final_permissions: {
31
      can_edit_site: true,
32
      can_edit_favicon: true,
33
      can_edit_schema: true,
34
      can_manage_menu: true,
35
      can_manage_users: true,
36
      can_manage_environments: true,
37
      can_manage_webhooks: true,
38
      environments_access: "primary_only",
39
      can_manage_sso: true,
40
      can_access_audit_log: true,
41
      can_manage_workflows: true,
42
      can_edit_environment: true,
43
      can_promote_environments: true,
44
      can_manage_shared_filters: true,
45
      can_manage_build_triggers: true,
46
      can_manage_upload_collections: true,
47
      can_manage_access_tokens: true,
48
      can_perform_site_search: true,
49
      can_access_build_events_log: true,
50
      positive_item_type_permissions: [{ environment: "main", action: "all" }],
51
      negative_item_type_permissions: [{ environment: "main", action: "all" }],
52
      positive_upload_permissions: [{ action: "all", environment: "main" }],
53
      negative_upload_permissions: [{ action: "all", environment: "main" }],
54
      positive_build_trigger_permissions: [{}],
55
      negative_build_trigger_permissions: [{}],
56
    },
57
  },
58
  inherits_permissions_from: [{ type: "role", id: "34" }],
59
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.