Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get Onezone user details

GET /zone/users/{id}

Returns the configuration information of the Onezone user.

Example cURL requests

Get Onezone user details

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

{
    "username": "someUser",
    "userId": "b519b3ac46823b2b83b6cb85e1b16f4fchaa0f",
    "fullName": "Unnamed User"
}

Path parameters

Parameter	Type & Description
id required	string Id of the user to be described.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE getOnezoneUser id=$USER_ID --host https://$OZ_PANEL_HOST:9443

Responses

application/json

200

Oneozne user details.

Property

Type & Description

userId

string

Unique user Id.

fullName

string

User's full name (given names + surname).

username

string

User's human-readable identifier, unique across the system. Makes it easier to identify the user and can be used for signing in with password.

Example

application/json

{
  "userId": "f1c8b1a37aa7447b22eb65a742d40524",
  "fullName": "Rudolf Lingens",
  "username": "r.lingens"
}

401

Unauthorized request.

403

Forbidden request.

404

The user does not exist.

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