DeleteGroup

client.Groups.Delete(ctx, body) (*GroupDeleteResponse, error)

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 param.Field[string]Optional

formatuuid

ReturnsExpand Collapse

type GroupDeleteResponse interface{…}

Empty response

DeleteGroup

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  group, err := client.Groups.Delete(context.TODO(), gitpod.GroupDeleteParams{
    GroupID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", group)
}

{}

Returns Examples

{}