DeleteMembership

client.groups.memberships.delete(, ?): MembershipDeleteResponse

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: MembershipDeleteParams { membershipId }

membershipId?: string

The membership to delete

formatuuid

ReturnsExpand Collapse

MembershipDeleteResponse = unknown

Empty response

DeleteMembership

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const membership = await client.groups.memberships.delete({
  membershipId: 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
});

console.log(membership);

{}

Returns Examples

{}