Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

List all named tokens

GET /tokens/named

Returns the list of all tokens in the system. The results include ids of users' and providers' named tokens - temporary tokens are not included as they are not persisted in the system.

Requires oz_tokens_manage admin privilege.

You can learn more about named and temporary tokens here.

Example cURL requests

List all named tokens

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

{
  "tokens": [
    "2b5d0dd5aa6443a69277b5ce0544fec2",
    "818bf8d4404c2bcee2b47f024f6c0890",
    "4a5e5dabcd55e03f1e9237eeca2548ff",
    "81336b59656653a481d1e65168f3f213"
  ]
}

Request Examples

Shell
onezone-rest-cli listAllNamedTokens

Responses

application/json
200

The list of all named token ids

Property
Type & Description
tokens
array of strings

List of token ids.

Example

application/json
{
  "tokens": [
    "2b5d0dd5aa6443a69277b5ce0544fec2",
    "818bf8d4404c2bcee2b47f024f6c0890",
    "4a5e5dabcd55e03f1e9237eeca2548ff",
    "81336b59656653a481d1e65168f3f213"
  ]
}
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."
  }
}