The Space Role Object

An object that represents a space role.

Properties

• id number

  Numeric Unique ID of a space role

• allowed_paths number[]

  Story IDs to which the user has access (acts as whitelist). If no item is selected, a user can access all content items.

• resolved_allowed_paths string[]

  Slugs of the stories listed in allowed_paths

• field_permissions string[]

  Hide specific fields from this role with an array of strings (based on the content schema)

• readonly_field_permissions string[]

  An array of hidden fields (based on the content schema)

• permissions enum[]

  An array of strings that define the permissions for the specific role. The following table includes a partial list of supported values. To get all possible values, update the permissions associated with a role, and then retrieve it.

  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 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 internationalization or variants)
  move_story	Move stories between folders
  edit_story_slug	Edit the URL of a story
  view_content	Controls the visibility of content entries. Without this, all content is hidden. To grant read-only access, set Allow reading content permission in the UI.
  view_folders	Controls the visibility of folders. Without this, all folders are hidden. To grant read-only access, set Allow reading content permission in the UI.
  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 of datasources
  access_commerce	Access e-commerce features
  manage_block_library	Manage components in the Block Library
  hide_asset_folders	Hides assets and folders for which the role doesn’t have upload permission. You can specify which folders are accessible in the UI.

• role string

  Role of a collaborator. Can be admin, editor, or custom roles.

• subtitle string

  Description of the role

• datasource_ids number[]

  An array of datasource IDs that the role can access. If none is selected, all datasources are accessible.

• component_ids number[]

  An array of component IDs that the role can access. If none is selected, all components are accessible.

• branch_ids number[]

  An array of pipeline IDs that the role can deploy. If none is selected, all pipelines are accessible.

• allowed_languages string[]

  List of languages (language codes) that the role can access. If none is selected, all languages are accessible.

• asset_folder_ids number[]

  An array of IDs of asset folders that the role can access. If none is selected, all asset folders are accessible.