DeleteGroup

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.

Body ParametersJSONExpand Collapse

groupId: optional string

formatuuid

DeleteGroup

curl https://app.gitpod.io/api/gitpod.v1.GroupService/DeleteGroup \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

{}

Returns Examples

{}