Delete an organization
Organization owners and cluster admins (`org.manage`). Asynchronous and resumable, like a team's deletion: the organization turns `deleting` at once (it takes no writes: 409 `org-deleting`; its teams answer 409 `team-deleting`), and the operation `org.delete` (target `/orgs/<id>`) deletes each of its teams with the team cascade (workspaces purged at once, managed services, registries, domains, git access defaults, shared vaults, namespace), then the organization with its memberships and invitations. Audit rows stay. Every member loses access when the deletion starts. Deleting a deleting organization returns its operation. The console asks to type the organization's name first. The installation's default organization (`tenancy.defaultOrg`) can be deleted too; core creates it again, empty, at its next start. When a team's deletion gives up, the operation fails with the problem `org-delete-failed`, whose `failed_team` names the team and why; the organization stays `deleting` and nothing polls any more. Deleting it again is the *Retry*: it answers a new `org.delete` operation (`Org.delete_operation_id` changes), restarts the failed team deletions (each with a new `team.delete` operation) and resumes the organization's.
openapi/harthelm.yaml at v1.5.0__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.
org*stringuuidAccepted; follow the Operation.
application/json- response
A long-running action. It ends in succeeded or failed and stays readable for 7 days.
id*stringuuidkind*stringWhat runs, for example workspace.create, workspace.delete, workspace.restore,
workspace.volume_owner, landscape.sync, landscape.teardown, workspace.archive,
workspace.restore_archive, managed_service.dump.
state*OperationState"pending""running""succeeded""failed"target?stringAPI path of the resource the operation acts on, e.g. /workspaces/123.
detail?stringHuman-readable progress, e.g. "Cloning repository".
error?RFC 9457 problem details.
created_at*stringdate-timeupdated_at*stringdate-timefinished_at?stringdate-timecurl -X DELETE 'https://console.example.com/api/v1/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "state": "pending", "target": "string", "detail": "string", "error": { "type": "about:blank", "title": "string", "status": 100, "detail": "string", "instance": "string", "errors": [ { "pointer": "string", "line": 1, "column": 1, "message": "string", "code": "string", "subject": "string" } ], "held_by_deleted": { "workspaces": 0, "storage_gib": 0 }, "failed_team": { "id": 1, "name": "string", "reason": "string" } }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z"}Create an organization
Cluster admins only (`platform.admin`). The caller becomes the organization's owner, or the existing user named as `owner` does; more owners and members join by invitation or `POST /orgs/{org}/members`. 409 `name-taken` when an organization of that name exists (names compare case-insensitively).
Get an organization
One organization as the caller sees it, with their role and permissions. Organizations the caller may not see answer 404.