ListProjectPolicies

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

Query ParametersExpand Collapse

token: optional string

pageSize: optional number

maximum100

minimum0

Body ParametersJSONExpand Collapse

pagination: optional object { token, pageSize }

pagination contains the pagination options for listing project policies

token: optional string

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

pageSize: optional number

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

formatint32

maximum100

projectId: optional string

project_id specifies the project identifier

formatuuid

ReturnsExpand Collapse

pagination: optional object { nextToken }

nextToken: optional string

Token passed for retrieving the next set of results. Empty if there are no more results

policies: optional array of ProjectPolicy { groupId, role }

groupId: optional string

formatuuid

role: optional 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

curl https://app.gitpod.io/api/gitpod.v1.ProjectService/ListProjectPolicies \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

{
  "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"
    }
  ]
}