The Collaborator Object

An object that represents a collaborator in a space. You can define roles and permissions, as well as other properties that are not read-only.

Learn more about permissions and roles for collaborators in the Space Roles endpoint.

Properties

• user object

  The user object inside a collaborator object.

  Show child properties

  • id number

    Numeric ID of a user

  • firstname string

    First name of a collaborator

  • lastname string

    Last name of a collaborator

  • alt_email string

    Email of a collaborator

  • avatar string

    Avatar of a collaborator (usually an image)

  • userid string

    User ID of a collaborator

  • friendly_name string

    Friendly name of a collaborator

• role string

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

• user_id number

  Numeric ID of a user

• permissions enum[]

  Allow a collaborator to perform specific actions. Add the permission as an array of strings.

  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.

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

• field_permissions string[]

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

• id number

  Numeric ID of a collaborator

• space_role_id number

  Numeric ID of a space role

• space_role_ids number[]

  Array of space role IDs

• space_id number

  Numeric ID of a space

Example Object

{
  "collaborators":[
     {
        "user":{
           "id":262115,
           "firstname":"Marve",
           "lastname":"Priscy",
           "alt_email":null,
           "avatar": "avatars/115866/5fgecfcb64/mayve.jpeg",
           "userid":"mayve@email.com",
           "friendly_name":"Marve Priscy"
        },
        "role":"49708",
        "user_id":262115,
        "permissions":["can_subscribe"],
        "allowed_path":"",
        "field_permissions":"",
        "id":236290,
        "space_role_id":"49708",
        "invitation":null,
        "space_role_ids":[],
        "space_id":866112
     }
  ]
}