Skip to content
Ona API Reference
Ona Docs
API Reference
Projects

Policies

CreateProjectPolicy
client.projects.policies.create(PolicyCreateParams { groupId, projectId, role } body, RequestOptionsoptions?): PolicyCreateResponse { policy }
POST/gitpod.v1.ProjectService/CreateProjectPolicy
DeleteProjectPolicy
client.projects.policies.delete(PolicyDeleteParams { groupId, projectId } body, RequestOptionsoptions?): PolicyDeleteResponse
POST/gitpod.v1.ProjectService/DeleteProjectPolicy
ListProjectPolicies
client.projects.policies.list(PolicyListParams { token, pageSize, pagination, projectId } params, RequestOptionsoptions?): PoliciesPage<ProjectPolicy { groupId, role } >
POST/gitpod.v1.ProjectService/ListProjectPolicies
UpdateProjectPolicy
client.projects.policies.update(PolicyUpdateParams { groupId, projectId, role } body, RequestOptionsoptions?): PolicyUpdateResponse { policy }
POST/gitpod.v1.ProjectService/UpdateProjectPolicy
ModelsExpand 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"
ProjectRole = "PROJECT_ROLE_UNSPECIFIED" | "PROJECT_ROLE_ADMIN" | "PROJECT_ROLE_USER" | "PROJECT_ROLE_EDITOR"
One of the following:
"PROJECT_ROLE_UNSPECIFIED"
"PROJECT_ROLE_ADMIN"
"PROJECT_ROLE_USER"
"PROJECT_ROLE_EDITOR"
PolicyCreateResponse { policy }
policy?: 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"
PolicyDeleteResponse = unknown
PolicyUpdateResponse { policy }
policy?: 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"