Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

List all space privileges

GET /spaces/privileges

Returns list of all possible space privileges.

This endpoint does not require authentication.

Example cURL requests

Get list of all space privileges

curl https://$ZONE_HOST/api/v3/onezone/spaces/privileges

{
  "admin": [
    "space_view",
    "space_update",
    "space_delete",
    "space_view_privileges",
    "space_set_privileges",
    "space_read_data",
    "space_write_data",
    "space_register_files",
    "space_manage_shares",
    "space_view_views",
    "space_manage_views",
    "space_query_views",
    "space_view_statistics",
    "space_view_changes_stream",
    "space_view_transfers",
    "space_schedule_replication",
    "space_cancel_replication",
    "space_schedule_eviction",
    "space_cancel_eviction",
    "space_view_qos",
    "space_manage_qos",
    "space_add_user",
    "space_remove_user",
    "space_add_group",
    "space_remove_group",
    "space_add_provider",
    "space_remove_provider",
    "space_add_harvester",
    "space_remove_harvester"
  ],
  "manager": [
    "space_view",
    "space_view_privileges",
    "space_read_data",
    "space_write_data",
    "space_register_files",
    "space_manage_shares",
    "space_view_views",
    "space_query_views",
    "space_view_statistics",
    "space_view_changes_stream",
    "space_view_transfers",
    "space_schedule_replication",
    "space_view_qos",
    "space_add_user",
    "space_remove_user",
    "space_add_group",
    "space_remove_group",
    "space_add_harvester",
    "space_remove_harvester"
  ],
  "member": [
    "space_view",
    "space_read_data",
    "space_write_data",
    "space_view_transfers"
  ]
}

Request Examples

Shell
onezone-rest-cli listSpacePrivileges

Responses

application/json
200

List of all space privileges

Property
Type & Description
admin
array of strings

A list of privileges in the space.

manager
array of strings

A subset of space privileges suggested for space managers.

member
array of strings

A subset of space privileges suggested for space members.

500

Internal server Error.

Property
Type & Description
error
object

Object describing an error.
id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}