Skip to content
Sluice

createUser

POST
/api/v1/users
curl --request POST \
  --url https://example.com/api/v1/users \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "name": "example", "password": "example", "role": "viewer" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string format: email
<= 320 characters
name
string
<= 200 characters
password
required

Temporary password. The user must change it at first login.

string
>= 10 characters <= 1024 characters
role
required
string
Allowed values: viewer operator editor admin
key
additional properties
any

Responses

Section titled “ Responses ”

201

Section titled “201”

Created

Media typeapplication/json
object
created_at
required
string format: date-time
disabled
required
boolean
email
required
string
id
required
string
last_login_at
string format: date-time
must_change_password
required
boolean
name
required
string
role
required
string
Allowed values: viewer operator editor admin
key
additional properties
any
Example
{
  "role": "viewer"
}

default

Section titled “default”

Error

Media typeapplication/json
object
error
required
object
code
required
string
details
message
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}