DeleteGroup
groups.delete(GroupDeleteParams**kwargs) -> object
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.
DeleteGroup
import os
from gitpod import Gitpod
client = Gitpod(
bearer_token=os.environ.get("GITPOD_API_KEY"), # This is the default and can be omitted
)
group = client.groups.delete(
group_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(group){}Returns Examples
{}