Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

List all group privileges

GET /groups/privileges

Returns list of all possible group privileges.

This endpoint does not require authentication.

Example cURL requests

Get list of all group privileges

curl https://$HOST/api/v3/onezone/groups/privileges

{
  "admin": [
    "group_view",
    "group_update",
    "group_delete",
    "group_view_privileges",
    "group_set_privileges",
    "group_add_parent",
    "group_leave_parent",
    "group_add_child",
    "group_remove_child",
    "group_add_user",
    "group_remove_user",
    "group_add_space",
    "group_leave_space",
    "group_create_handle_service",
    "group_leave_handle_service",
    "group_create_handle",
    "group_leave_handle",
    "group_add_harvester",
    "group_remove_harvester"
  ],
  "manager": [
    "group_view",
    "group_view_privileges",
    "group_add_parent",
    "group_leave_parent",
    "group_add_child",
    "group_remove_child",
    "group_add_user",
    "group_remove_user",
    "group_add_harvester",
    "group_remove_harvester"
  ],
  "member": [
    "group_view"
  ]
}

Request Examples

Shell
onezone-rest-cli listGroupPrivileges

Responses

application/json
200

List of all group privileges

PropertyType & Description
admin
array of strings

A list of privileges in the group.

manager
array of strings

A subset of group privileges suggested for group managers.

member
array of strings

A subset of group privileges suggested for group members.

500

Internal server Error.

PropertyType & 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."
  }
}