Skip to content
Ona API Reference
Ona Docs
API Reference
Groups

DeleteGroup

client.groups.delete(GroupDeleteParams { groupId } body, RequestOptionsoptions?): GroupDeleteResponse
POST/gitpod.v1.GroupService/DeleteGroup

Deletes a group and removes all its resource assignments.

When a group is deleted, all resource assignments revert to org-level scope.

Use this method to:

  • Remove unused groups
  • Clean up after team reorganization

Examples

  • Delete a group:

    Permanently removes a group.

    groupId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"

Authorization

Requires org:admin role on the organization.

ParametersExpand Collapse
body: GroupDeleteParams { groupId }
groupId?: string
formatuuid
ReturnsExpand Collapse
GroupDeleteResponse = unknown

Empty response

DeleteGroup

import Gitpod from '@gitpod/sdk';

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

const group = await client.groups.delete({ groupId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68' });

console.log(group);
{}
Returns Examples
{}