Users

Create a user

POST/api/users

Creates a user account with the supplied username, password, and role.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Request body

Name	Type	Description
id	string	Unique identifier of the resource.
passwordrequired	string	Password used to authenticate the account.
rolerequired	enum<string>	Permission role assigned to the user. Options: `admin`, `user`, `view-only`
usernamerequired	string	Username of the account.

Example request

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "password": "string",
  "role": "admin",
  "username": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
idrequired	string	Unique identifier of the resource.
rolerequired	string	Permission role assigned to the user.
usernamerequired	string	Username of the account.

200 example

{
  "id": "string",
  "role": "string",
  "username": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/users' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "password": "string",
  "role": "admin",
  "username": "string"
}'

PreviousSet up two-factor authentication NextDelete a user