DeleteRoleAssignment

client.groups.roleAssignments.delete(, ?): RoleAssignmentDeleteResponse

POST/gitpod.v1.GroupService/DeleteRoleAssignment

Deletes a role assignment.

Use this method to:

Remove group access to resources
Revoke role-based permissions

Examples

Delete a role assignment:

Removes a role assignment by its ID.
```
assignmentId: "a1b2c3d4-5678-90ab-cdef-1234567890ab"
```

Authorization

Requires admin role on the specific resource.

ParametersExpand Collapse

body: RoleAssignmentDeleteParams { assignmentId }

assignmentId?: string

formatuuid

ReturnsExpand Collapse

RoleAssignmentDeleteResponse = unknown

Empty response

DeleteRoleAssignment

import Gitpod from '@gitpod/sdk';

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

const roleAssignment = await client.groups.roleAssignments.delete({
  assignmentId: 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
});

console.log(roleAssignment);

{}

Returns Examples

{}