Users API

Manage user accounts. Creating, updating, and deleting users requires Super Admin (manage:all) permission.

List All Users

List all users

GET

/v1/users

Returns all user accounts in the system. Requires read:users permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

List of users.

Content-Type

application/json

[

  

{

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"first_name": "Jane",

  

  

"last_name": "Doe",

  

  

"email": "[email protected]",

  

  

"role": {

  

  

  

"id": "clx1y2z3a0000b4d2",

  

  

  

"slug": "predefined_super_admin",

  

  

  

"name": "Super Admin",

  

  

  

"policies": [

  

  

  

  

{

  

  

  

  

  

"action": "read",

  

  

  

  

  

"subject": "archive",

  

  

  

  

  

"conditions": {

  

  

  

  

  

}

  

  

  

  

}

  

  

  

],

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string"

  

  

},

  

  

"createdAt": "string"

  

}

]

GET

/v1/users

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Create a User

Create a user

POST

/v1/users

Creates a new user account and optionally assigns a role. Requires manage:all (Super Admin) permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Request Body

application/json

{

  

"email": "[email protected]",

  

"first_name": "Jane",

  

"last_name": "Doe",

  

"password": "securepassword123",

  

"roleId": "clx1y2z3a0000b4d2"

}

Responses

User created.

Content-Type

application/json

{

  

"id": "clx1y2z3a0000b4d2",

  

"first_name": "Jane",

  

"last_name": "Doe",

  

"email": "[email protected]",

  

"role": {

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"slug": "predefined_super_admin",

  

  

"name": "Super Admin",

  

  

"policies": [

  

  

  

{

  

  

  

  

"action": "read",

  

  

  

  

"subject": "archive",

  

  

  

  

"conditions": {

  

  

  

  

}

  

  

  

}

  

  

],

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"createdAt": "string"

}

POST

/v1/users

Playground

Authorization

bearerAuth

Body

Samples

Powered by VitePress OpenAPI

Get a User

Get a user

GET

/v1/users/{id}

Returns a single user by ID. Requires read:users permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Parameters

Path Parameters

id*

Type

string

Required

Example"clx1y2z3a0000b4d2"

Responses

User details.

Content-Type

application/json

{

  

"id": "clx1y2z3a0000b4d2",

  

"first_name": "Jane",

  

"last_name": "Doe",

  

"email": "[email protected]",

  

"role": {

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"slug": "predefined_super_admin",

  

  

"name": "Super Admin",

  

  

"policies": [

  

  

  

{

  

  

  

  

"action": "read",

  

  

  

  

"subject": "archive",

  

  

  

  

"conditions": {

  

  

  

  

}

  

  

  

}

  

  

],

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"createdAt": "string"

}

GET

/v1/users/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI

Update a User

Update a user

PUT

/v1/users/{id}

Updates a user's email, name, or role assignment. Requires manage:all (Super Admin) permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Parameters

Path Parameters

id*

Type

string

Required

Example"clx1y2z3a0000b4d2"

Request Body

application/json

{

  

"email": "string",

  

"first_name": "string",

  

"last_name": "string",

  

"roleId": "string"

}

Responses

Updated user.

Content-Type

application/json

{

  

"id": "clx1y2z3a0000b4d2",

  

"first_name": "Jane",

  

"last_name": "Doe",

  

"email": "[email protected]",

  

"role": {

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"slug": "predefined_super_admin",

  

  

"name": "Super Admin",

  

  

"policies": [

  

  

  

{

  

  

  

  

"action": "read",

  

  

  

  

"subject": "archive",

  

  

  

  

"conditions": {

  

  

  

  

}

  

  

  

}

  

  

],

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"createdAt": "string"

}

PUT

/v1/users/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

Powered by VitePress OpenAPI

Delete a User

Delete a user

DELETE

/v1/users/{id}

Permanently deletes a user. Cannot delete the last remaining user. Requires manage:all (Super Admin) permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Parameters

Path Parameters

id*

Type

string

Required

Example"clx1y2z3a0000b4d2"

Responses

User deleted. No content returned.

DELETE

/v1/users/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI

Get Current User Profile

Get current user profile

GET

/v1/users/profile

Returns the profile of the currently authenticated user.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

Current user's profile.

Content-Type

application/json

{

  

"id": "clx1y2z3a0000b4d2",

  

"first_name": "Jane",

  

"last_name": "Doe",

  

"email": "[email protected]",

  

"role": {

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"slug": "predefined_super_admin",

  

  

"name": "Super Admin",

  

  

"policies": [

  

  

  

{

  

  

  

  

"action": "read",

  

  

  

  

"subject": "archive",

  

  

  

  

"conditions": {

  

  

  

  

}

  

  

  

}

  

  

],

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"createdAt": "string"

}

GET

/v1/users/profile

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Update Current User Profile

Update current user profile

PATCH

/v1/users/profile

Updates the email, first name, or last name of the currently authenticated user. Disabled in demo mode.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Request Body

application/json

{

  

"email": "string",

  

"first_name": "string",

  

"last_name": "string"

}

Responses

Updated user profile.

Content-Type

application/json

{

  

"id": "clx1y2z3a0000b4d2",

  

"first_name": "Jane",

  

"last_name": "Doe",

  

"email": "[email protected]",

  

"role": {

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"slug": "predefined_super_admin",

  

  

"name": "Super Admin",

  

  

"policies": [

  

  

  

{

  

  

  

  

"action": "read",

  

  

  

  

"subject": "archive",

  

  

  

  

"conditions": {

  

  

  

  

}

  

  

  

}

  

  

],

  

  

"createdAt": "string",

  

  

"updatedAt": "string"

  

},

  

"createdAt": "string"

}

PATCH

/v1/users/profile

Playground

Authorization

bearerAuth

Body

Samples

Powered by VitePress OpenAPI

Update Password

Update password

POST

/v1/users/profile/password

Updates the password of the currently authenticated user. The current password must be provided for verification. Disabled in demo mode.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Request Body

application/json

{

  

"currentPassword": "string",

  

"newPassword": "string"

}

Responses

Password updated successfully.

Content-Type

application/json

{

  

"message": "Operation completed successfully."

}

POST

/v1/users/profile/password

Playground

Authorization

bearerAuth

Body

Samples

Powered by VitePress OpenAPI