Management API

The Space Role Object

Properties

• id

  number

  Numeric Unique ID of the space role

• allowed_paths

  number[]

  Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.

• resolved_allowed_paths

  string[]

  Resolved allowed_paths for displaying paths

• field_permissions

  string[]

  Hide specific fields for this user with an array of strings with the schema: "component_name.field_name"

• readonly_field_permissions

  string[]

  An array of defined fields that are hidden for the specific role. The schema used is component_name.field_name

• permissions

  enum[]

  An array of strings that defines the permissions for the a specific role. These are a few examples, but there are more value that can be present or used.

  Try changing the role permissions and retrieve a role to see all the possible values

  Permission	Description
  read_stories	View stories without editing
  save_stories	Edit and save stories
  publish_stories	Publish stories to the live environment
  unpublish_stories	Unpublish stories from the live environment
  publish_folders	Publish entire folders and their contents
  unpublish_folders	Unpublish folders and their contents
  deploy_stories	Deploy pipeline stories
  delete_stories	Permanently delete stories
  edit_image	Edit images in the asset manager
  view_composer	View the Visual Editor
  change_alternate_group	Change alternate content groupings (for i18n or variants)
  move_story	Move stories between folders
  edit_story_slug	Edit the URL slug of a story
  view_content	Controls visibility of content entries. Without this, all content is hidden unless explicitly granted. To give read-only access to others, enable allow reading content permission.
  view_folders	Controls visibility of folders. Without this, all folders are hidden unless explicitly granted. To give read-only access to others, enable allow reading content permission.
  view_draft_json	View the draft JSON payload of stories
  view_published_json	View the published JSON payload of stories
  manage_tags	Create, edit, or delete tags
  edit_datasources	Edit datasources
  edit_datasource_keys	Edit keys inside datasources
  access_commerce	Access commerce-related features
  manage_block_library	Manage components in the Block Library
  hide_asset_folders	Hides assets and folders (including subfolders) that the role doesn't have upload permission for. In the UI, you can specify which folders are accessible.

• role

  string

  Role of the collaborator, could be admin, editor or custom roles

• subtitle

  string

  Description of the role

• datasource_ids

  number[]

  An array of datasource IDs that can be accessed by the role. If no IDs is added, the user has rights to edit all datasources.

• component_ids

  number[]

  An array of IDs of components that the user role cannot select/use. If none is present/selected, the user role has rights to all components.

• branch_ids

  number[]

  An array of IDs of pipelines that the user role has right to deploy. If none is present/selected, the user role can access all the pipelines.

• allowed_languages

  string[]

  List of languages (language codes) that the user role has access to. If none is present/selected, the user role has right to all the languages.

• asset_folder_ids

  number[]

  An array of IDs of asset folders that the user role has access to. If none is present/selected, the user role can access all the asset folders.