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
  publish_stories	Allow publishing of content entries
  save_stories	Allow editing and saving of content entries
  edit_datasources	Allow editing and saving of datasources
  access_commerce	Allow access to commerce app
  edit_story_slug	Deny the change of slugs of content entries
  move_story	Deny moving of content entries
  view_composer	Deny access to visual composer

• 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.