DeleteMembership

groups.memberships.delete() -> object

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

membership_id: Optional[str]

The membership to delete

formatuuid

ReturnsExpand Collapse

object

DeleteMembership

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
membership = client.groups.memberships.delete(
    membership_id="a1b2c3d4-5678-90ab-cdef-1234567890ab",
)
print(membership)

{}

Returns Examples

{}