Harthelm Docs
REST APITeams

Get a team

One team with the caller's role and permissions. Needs `team.view`; a team the caller may not see answers 404.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/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

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 GET 'https://console.example.com/api/v1/teams/1'
{  "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"  ]}

The team's quota and usage

Every member (`team.view`): the installation default, the team's override, the effective quota (what the namespace's ResourceQuota and the pre-checks on create, Sync and wake use) and the current usage, counted like the pre-checks count it.

List the caller's teams

The caller's teams; cluster admins see every team.