Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Create Onezone user

POST /zone/users

Creates a new Onezone user account with Basic (username & password) authentication enabled.

Example cURL requests

Create Onezone user with username & password

curl -H "X-Auth-Token: $TOKEN" -X POST https://$OZ_PANEL_HOST/api/v3/onepanel/zone/users \
-H "Content-Type: application/json" -d '{
    "username": "someUser",
    "password": "somePassword"
}'

{
    "id": "b519b3ac46823b2b83b6cb85e1b16f4fchaa0f"
}

Request body

application/json

The user configuration details.

Property	Type & Description
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.
password string User's password (in plaintext).
fullName string User's full name (given names + surname).
groups array of strings Ids of Onezone groups to which the user should be added. The groups must already exist.

Request Examples

application/json

{
  "username": "admin",
  "password": "somePassword",
  "groups": [
    "admins"
  ]
}

Responses

application/json

201

No description.

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