ListProjectPolicies

client.projects.policies.list(, ?): PoliciesPage<ProjectPolicy { groupId, role } >

POST/gitpod.v1.ProjectService/ListProjectPolicies

Lists policies for a project.

Use this method to:

View access controls
Check policy configurations
Audit permissions

Examples

List policies:

Shows all policies for a project.

projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
pagination:
  pageSize: 20

ParametersExpand Collapse

params: PolicyListParams { token, pageSize, pagination, projectId }

token?: string

Query param

pageSize?: number

Query param

maximum100

minimum0

pagination?: Pagination

Body param: pagination contains the pagination options for listing project policies

token?: string

Token for the next set of results that was returned as next_token of a PaginationResponse

pageSize?: number

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

projectId?: string

Body param: project_id specifies the project identifier

formatuuid

ReturnsExpand Collapse

ProjectPolicy { groupId, role }

groupId?: string

formatuuid

role?: ProjectRole

role is the role assigned to the group

One of the following:

"PROJECT_ROLE_UNSPECIFIED"

"PROJECT_ROLE_ADMIN"

"PROJECT_ROLE_USER"

"PROJECT_ROLE_EDITOR"

ListProjectPolicies

import Gitpod from '@gitpod/sdk';

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

// Automatically fetches more pages as needed.
for await (const projectPolicy of client.projects.policies.list({
  pagination: { pageSize: 20 },
  projectId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
})) {
  console.log(projectPolicy.groupId);
}

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "policies": [
    {
      "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "role": "PROJECT_ROLE_UNSPECIFIED"
    }
  ]
}

Returns Examples

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "policies": [
    {
      "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "role": "PROJECT_ROLE_UNSPECIFIED"
    }
  ]
}