Skip to content
Olivares AI docs

Create a user (superadmin)

POST
/v1/users
 
curl --request POST \
  --url https://example.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "email": "hello@example.com", "password": "example", "role": "example", "superadmin": false, "tenant": "example", "workspace_id": "example" }'

Creates one user account. Superadmin only.

Authorizations

Section titled “ Authorizations ”

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
display_name
string
email
required
string format: email
password
required
string format: password
>= 12 characters
role

The role granted in tenant

string
superadmin
boolean
tenant

Optional tenant granted role in the create transaction

string
workspace_id

Optional workspace the membership is confined to

string

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
created_at
required
string format: date-time
display_name
string
email
required
string format: email
id
required
string format: uuid
is_superadmin
required
boolean
membership

The first membership, granted in the create transaction when tenant was given

object
id
string format: uuid
role
string
tenant
string
user_id
string format: uuid
workspace_id
string
status
required
string
Allowed values: active inactive
Example 
{
  "status": "active"
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}