Users
5 endpoints — 3 GET, 1 POST, 1 DELETE
GET /api/v1/userAUTH
Returns all registered users (public fields only).
This endpoint requires a valid JWT Bearer token in the Authorization header.
Responses
200Ok
GET /api/v1/user/{id}AUTH
Returns a single user by username.
This endpoint requires a valid JWT Bearer token in the Authorization header.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Responses
200Ok404Not Found
GET /api/v1/user/{username}/ssh-key-fingerprintsAUTH
Returns the SSH key fingerprints for a user. Users may view their own keys; admins may view any user's keys.
This endpoint requires a valid JWT Bearer token in the Authorization header.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
username | path | string | Yes |
Responses
200Ok401Unauthorized403Forbidden500Internal Server Error
POST /api/v1/user/{username}/ssh-keysAUTH
Adds an SSH public key to a user's account. Users may add keys to their own account; admins may add to any account.
This endpoint requires a valid JWT Bearer token in the Authorization header.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
username | path | string | Yes |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
publicKey | string | No | |
name | string | No |
Responses
200Ok400Bad Request401Unauthorized403Forbidden404Not Found409Conflict500Internal Server Error
DELETE /api/v1/user/{username}/ssh-keys/{fingerprint}AUTH
Removes an SSH public key from a user's account by fingerprint. Users may remove keys from their own account; admins may remove from any account.
This endpoint requires a valid JWT Bearer token in the Authorization header.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
username | path | string | Yes | |
fingerprint | path | string | Yes |
Responses
200Ok401Unauthorized403Forbidden404Not Found500Internal Server Error