Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

List all admin privileges.

GET /privileges

Returns list of all possible Onezone admin privileges.

This endpoint does not require authentication.

Example cURL requests

Get list of all Onezone admin privileges

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

{
  "admin": [
    "oz_view_privileges",
    "oz_set_privileges",
    "oz_users_list",
    "oz_users_view",
    "oz_users_create",
    "oz_users_manage_passwords",
    "oz_users_update",
    "oz_users_delete",
    "oz_users_list_relationships",
    "oz_users_add_relationships",
    "oz_users_remove_relationships",
    "oz_groups_list",
    "oz_groups_view",
    "oz_groups_create",
    "oz_groups_update",
    "oz_groups_delete",
    "oz_groups_view_privileges",
    "oz_groups_set_privileges",
    "oz_groups_list_relationships",
    "oz_groups_add_relationships",
    "oz_groups_remove_relationships",
    "oz_spaces_list",
    "oz_spaces_view",
    "oz_spaces_create",
    "oz_spaces_update",
    "oz_spaces_delete",
    "oz_spaces_view_privileges",
    "oz_spaces_set_privileges",
    "oz_spaces_list_relationships",
    "oz_spaces_add_relationships",
    "oz_spaces_remove_relationships",
    "oz_shares_list",
    "oz_shares_view",
    "oz_shares_create",
    "oz_shares_update",
    "oz_shares_delete",
    "oz_providers_list",
    "oz_providers_view",
    "oz_providers_update",
    "oz_providers_delete",
    "oz_providers_list_relationships",
    "oz_providers_invite",
    "oz_handle_services_list",
    "oz_handle_services_view",
    "oz_handle_services_create",
    "oz_handle_services_update",
    "oz_handle_services_delete",
    "oz_handle_services_view_privileges",
    "oz_handle_services_set_privileges",
    "oz_handle_services_list_relationships",
    "oz_handle_services_add_relationships",
    "oz_handle_services_remove_relationships",
    "oz_handles_list",
    "oz_handles_view",
    "oz_handles_create",
    "oz_handles_update",
    "oz_handles_delete",
    "oz_handles_view_privileges",
    "oz_handles_set_privileges",
    "oz_handles_list_relationships",
    "oz_handles_add_relationships",
    "oz_handles_remove_relationships",
    "oz_harvesters_list",
    "oz_harvesters_view",
    "oz_harvesters_create",
    "oz_harvesters_update",
    "oz_harvesters_delete",
    "oz_harvesters_view_privileges",
    "oz_harvesters_set_privileges",
    "oz_harvesters_list_relationships",
    "oz_harvesters_add_relationships",
    "oz_harvesters_remove_relationships",
    "oz_clusters_list",
    "oz_clusters_view",
    "oz_clusters_update",
    "oz_clusters_view_privileges",
    "oz_clusters_set_privileges",
    "oz_clusters_list_relationships",
    "oz_clusters_add_relationships",
    "oz_clusters_remove_relationships"
  ],
  "viewer": [
    "oz_users_list",
    "oz_users_view",
    "oz_users_list_relationships",
    "oz_groups_list",
    "oz_groups_view",
    "oz_groups_list_relationships",
    "oz_spaces_list",
    "oz_spaces_view",
    "oz_spaces_list_relationships",
    "oz_shares_list",
    "oz_shares_view",
    "oz_providers_list",
    "oz_providers_view",
    "oz_providers_list_relationships",
    "oz_handle_services_list",
    "oz_handle_services_view",
    "oz_handle_services_list_relationships",
    "oz_handles_list",
    "oz_handles_view",
    "oz_handles_list_relationships",
    "oz_harvesters_list",
    "oz_harvesters_view",
    "oz_harvesters_list_relationships",
    "oz_clusters_list",
    "oz_clusters_view",
    "oz_clusters_list_relationships"
  ]
}

Request Examples

Shell

onezone-rest-cli listPrivileges

Responses

application/json

200

List of all Onezone admin privileges

Property	Type & Description
admin array of strings A list of admin privileges in Onezone.
viewer array of strings A subset of zone admin privileges suggested for zone viewers.

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