Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

List current user privileges

GET /user/privileges

Returns the list of currently authenticated user's admin privileges in Onezone.

This operation can be invoked on behalf of the current user only.

Example cURL requests

List current user's admin privileges in Onezone

curl -u username:password -X GET  \
https://$ZONE_HOST/api/v3/onezone/user/privileges

{
  "privileges": [
    "oz_view_privileges",
    "oz_users_list",
    "oz_users_view",
    "oz_groups_list",
    "oz_groups_view",
    "oz_spaces_list",
    "oz_spaces_view",
    "oz_shares_list",
    "oz_shares_view",
    "oz_providers_list",
    "oz_providers_view",
    "oz_handle_services_list",
    "oz_handle_services_view",
    "oz_handles_list",
    "oz_handles_view"
  ]
}

Request Examples

Shell
onezone-rest-cli listCurrentUserAdminPrivileges

Responses

application/json
200

The list of user's admin privileges in Onezone.

Property
Type & Description
privileges
array of strings

A list of admin privileges in Onezone.

Example

application/json
{
  "privileges": [
    "oz_view_privileges",
    "oz_users_list",
    "oz_users_view",
    "oz_groups_list",
    "oz_groups_view",
    "oz_spaces_list",
    "oz_spaces_view",
    "oz_shares_list",
    "oz_shares_view",
    "oz_providers_list",
    "oz_providers_view",
    "oz_handle_services_list",
    "oz_handle_services_view",
    "oz_handles_list",
    "oz_handles_view"
  ]
}
400

Invalid request.

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

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

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

Resource not found.

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