Harthelm Docs
REST APITeams

Change a team's settings

`name` needs `team.manage` (409 `name-taken`, audited as `team.update`). `allow_run_as_user` is for cluster admins only: it lets the team's container services set `runAsUser`, root included; while it is on, the team's namespace enforces Pod Security `baseline` instead of `restricted`. Without it, every workspace pod runs as the UID that owns its volume and a Plan that sets `runAsUser` has the blocker `run-as-not-allowed`. Audited as `team.settings`. A deleting team answers 409 `team-deleting`.

Generated from openapi/harthelm.yaml at v1.5.0
PATCH
/teams/{team}

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.

Path Parameters

team*integer

Numeric resource id.

Formatint64
Range1 <= value

Request Body

application/json
  1. body
Properties1 <= properties
name?TenantName

1 to 64 characters without leading or trailing spaces; unique case-insensitively.

Match^\S(.*\S)?$
Length1 <= length <= 64
allow_run_as_user?boolean

Container services of the team may set runAsUser, root included (cluster admins only).

Response Body

The team.

application/json
  1. response
id*ID

Numeric resource id.

Formatint64
Range1 <= value
org_id*string
Formatuuid
name*string
role?TeamRole

The caller's role; absent when a cluster admin sees a team they are not a member of.

Value in"admin""member"
created_at*string
Formatdate-time
allow_run_as_user?boolean

Container services of the team may set runAsUser, root included (a cluster admin sets it with PATCH /teams/{team}). Absent for an older core.

deleting?boolean

The team is being deleted; it takes no writes. Absent for an older core.

delete_operation_id?string

The team.delete operation of a deleting team.

Formatuuid
permissions?array<>

The caller's permissions on the resource; the UI shows only what they allow. Absent for an older core.

curl -X PATCH 'https://console.example.com/api/v1/teams/1' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": 1,  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "name": "string",  "role": "admin",  "created_at": "2019-08-24T14:15:22Z",  "allow_run_as_user": true,  "deleting": true,  "delete_operation_id": "2a58cc5e-4ba9-418a-8f8b-9007f099696a",  "permissions": [    "string"  ]}

Override the team's quota

Cluster admins only (`platform.admin`). Replaces the override; quantities it leaves out take the installation default. Workspaces that run keep running when the new quota is smaller; the next create, Sync or wake is checked against it. Audited as `team.quota`.

The JSON Schema of harthelm.yml

`schemas/harthelm.schema.json` (draft 2020-12, schema `harthelm/v1`), served from the binary so editors and code-server's YAML extension never fetch it from the internet. Works without credentials.