Skip to content
Ona Docs

DeleteProjectPolicy

client.projects.policies.delete(PolicyDeleteParams { groupId, projectId } body, RequestOptionsoptions?): PolicyDeleteResponse
POST/gitpod.v1.ProjectService/DeleteProjectPolicy

Deletes a project policy.

Use this method to:

  • Remove access controls
  • Revoke permissions
  • Clean up policies

Examples

  • Delete policy:

    Removes a group’s access policy.

    projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
ParametersExpand Collapse
body: PolicyDeleteParams { groupId, projectId }
groupId?: string

group_id specifies the group_id identifier

formatuuid
projectId?: string

project_id specifies the project identifier

formatuuid
ReturnsExpand Collapse
PolicyDeleteResponse = unknown

DeleteProjectPolicy

import Gitpod from '@gitpod/sdk';

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

const policy = await client.projects.policies.delete({
  groupId: 'f53d2330-3795-4c5d-a1f3-453121af9c60',
  projectId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
});

console.log(policy);
{}
Returns Examples
{}