Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

List Onezone users

GET /zone/users

List Ids of Onezone users.

Example cURL requests

Get Onezone user ids

curl -H "X-Auth-Token: $TOKEN" -X GET https://$OZ_PANEL_HOST/api/v3/onepanel/zone/users

{
    "ids": [
        "f891d1ddf693232bbf0c11fe3cd9f7e7cheda9",
        "eefc8a11e1776d0797969ccf0b59c6dcch73dc",
        "ec0a39261b325cdc74e9c2d6b54fa786ch0419"
    ]
}

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getOnezoneUsers --host https://$OZ_PANEL_HOST:9443

Responses

application/json
200

List of user Ids.

Property
Type & Description
ids
array of strings

List of ids.

Example

application/json
{
  "ids": [
    "26cbc2b20f92416eb9f3cba65e50c1d2",
    "9ad94a9296d145a1a2b894f5fd7f48b0",
    "95ad2c09508f47198635e46a6ea4d005"
  ]
}
400

Invalid request.

Property
Type & Description
error
object (ErrorDetails)

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

Forbidden request.

500

Internal server error.

Property
Type & Description
error
object (ErrorDetails)

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