DeleteOrganization

client.organizations.delete(, ?): OrganizationDeleteResponse

POST/gitpod.v1.OrganizationService/DeleteOrganization

Permanently deletes an organization.

Use this method to:

Remove unused organizations
Clean up test organizations
Complete organization migration

Examples

Delete organization:

Permanently removes an organization and all its data.
```
organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
```

ParametersExpand Collapse

body: OrganizationDeleteParams { organizationId }

organizationId: string

organization_id is the ID of the organization to delete

formatuuid

ReturnsExpand Collapse

OrganizationDeleteResponse = unknown

DeleteOrganization

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const organization = await client.organizations.delete({
  organizationId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
});

console.log(organization);

{}

Returns Examples

{}