DeleteMembership

client.Groups.Memberships.Delete(ctx, body) (*GroupMembershipDeleteResponse, error)

POST/gitpod.v1.GroupService/DeleteMembership

Deletes a membership for a user in a group.

Use this method to:

Remove users from groups
Revoke group-based permissions

Examples

Remove a user from a group:

Deletes a membership by its ID.
```
membershipId: "a1b2c3d4-5678-90ab-cdef-1234567890ab"
```

Authorization

Requires org:admin permission on the organization or group:admin permission on the specific group.

ParametersExpand Collapse

body GroupMembershipDeleteParams

MembershipID param.Field[string]Optional

The membership to delete

formatuuid

ReturnsExpand Collapse

type GroupMembershipDeleteResponse interface{…}

Empty response

DeleteMembership

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"),
  )
  membership, err := client.Groups.Memberships.Delete(context.TODO(), gitpod.GroupMembershipDeleteParams{
    MembershipID: gitpod.F("a1b2c3d4-5678-90ab-cdef-1234567890ab"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", membership)
}

{}

Returns Examples

{}