Users

Manage user accounts and their roles. All endpoints require admin authentication.

User Object

{
  "id": "clxyz123456789abcdef",
  "username": "john_doe",
  "role": {
    "id": "clxyz123456789abcdef",
    "name": "admin"
  }
}

GET /v1/users

Retrieve all users.

Authentication: Bearer token (admin)

Response 200 OK

[
  {
    "id": "clxyz123456789abcdef",
    "username": "john_doe",
    "role": {
      "id": "clxyz123456789abcdef",
      "name": "admin"
    }
  }
]

Errors

GET /v1/users/{id}

Retrieve a single user by ID.

Authentication: Bearer token (admin)

Path Parameters

Response 200 OK

Returns a User Object.

Errors

POST /v1/users

Create a new user.

Authentication: Bearer token (admin)

Request Body

{
  "username": "john_doe",
  "password": "password123",
  "roleId": "clxyz123456789abcdef"
}

Response 201 Created

Returns the created User Object.

Errors

PUT /v1/users/{id}

Update an existing user.

Authentication: Bearer token (admin)

Path Parameters

Request Body

{
  "username": "john_doe",
  "password": "newpassword123",
  "roleId": "clxyz123456789abcdef"
}

Response 200 OK

Returns the updated User Object.

Errors

DELETE /v1/users/{id}

Delete a user.

Authentication: Bearer token (admin)

Path Parameters

Response 204 No Content

Errors