Skip to content

Create a user

POST
/api/v1/users

Creates an enabled user with an ADMIN, OPERATOR, or VIEWER role. The password is accepted only for hashing and is never returned. ADMIN and CSRF are required.

ADMIN request for creating a user.

object
password
required

Initial password accepted only for hashing and never returned.

string
role
required

Initial global role.

string
Allowed values: ADMIN OPERATOR VIEWER
username
required

Unique username.

string
Example
replication-operator

User created

Public user administration record. Password hashes and credentials are never exposed.

object
createdAt

Creation timestamp in UTC.

string format: date-time
enabled

Whether the account may authenticate.

boolean
id

User identifier.

string format: uuid
role

Global authorization role.

string
Allowed values: ADMIN OPERATOR VIEWER
updatedAt

Last update timestamp in UTC.

string format: date-time
username

Current username.

string

The request is malformed or fails validation.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

Authentication is required or credentials are invalid.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

The authenticated identity lacks the required permission.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

The request conflicts with the current resource or run state.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference