Harthelm Docs
REST APIAdmin

Every user of the installation

Cluster admins only (`platform.admin`; `hart admin users`). Every user of the installation, disabled ones included, ordered by email (ignoring case) and id. `q` is matched as plain text, not as a pattern.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/admin/users

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Query Parameters

limit?integer

Maximum number of items per page.

Range1 <= value <= 200
Default50
cursor?string

Opaque cursor from next_cursor of the previous page.

Lengthlength <= 1024
q?string

Only users whose email or name contains this text (case-insensitive).

Lengthlength <= 200

Response Body

A page of users.

application/json
  1. response
next_cursor?string

Absent on the last page.

items*array<>
curl -X GET 'https://console.example.com/api/v1/admin/users'
{  "next_cursor": "string",  "items": [    {      "id": 1,      "email": "string",      "name": "string",      "is_cluster_admin": true,      "email_verified": true,      "picture_url": "string",      "issuer": "string",      "disabled": true,      "created_at": "2019-08-24T14:15:22Z",      "last_login_at": "2019-08-24T14:15:22Z"    }  ]}

Install a licence

Cluster admins only (`platform.admin`; `hart admin license install`). Checks the licence offline (signature, format, revocation list, the installations it names, its end) and stores it; nothing is sent anywhere. A licence whose term starts later is kept and takes over on its start date. Installing the same licence again changes nothing. Audited as `license.install`. `409` while the Helm values manage the licence (`license.existingSecret`), `422` for a licence this installation does not accept (the detail says why).

The audit log

Cluster admins only (`platform.admin`; `hart admin audit`). The audit log, newest first (by time, then id); the filters combine. A malformed `action`, a cursor this API did not return or an `actor` or `team` below 1 is `422`; a malformed time is `400`.