Skip to content
Ona API Reference
Ona Docs
API Reference
Runners
Policies

CreateRunnerPolicy

runners.policies.create(PolicyCreateParams**kwargs) -> PolicyCreateResponse
POST/gitpod.v1.RunnerService/CreateRunnerPolicy

Creates a new policy for a runner.

Use this method to:

  • Set up access controls
  • Define group permissions
  • Configure role-based access

Examples

  • Create admin policy:

    Grants admin access to a group.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
role: RUNNER_ROLE_ADMIN
ParametersExpand Collapse
group_id: Optional[str]

group_id specifies the group_id identifier

formatuuid
role: Optional[RunnerRole]
One of the following:
"RUNNER_ROLE_UNSPECIFIED"
"RUNNER_ROLE_ADMIN"
"RUNNER_ROLE_USER"
runner_id: Optional[str]

runner_id specifies the project identifier

formatuuid
ReturnsExpand Collapse
class PolicyCreateResponse: …
policy: RunnerPolicy
group_id: Optional[str]
formatuuid
role: Optional[RunnerRole]

role is the role assigned to the group

One of the following:
"RUNNER_ROLE_UNSPECIFIED"
"RUNNER_ROLE_ADMIN"
"RUNNER_ROLE_USER"

CreateRunnerPolicy

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
policy = client.runners.policies.create(
    group_id="f53d2330-3795-4c5d-a1f3-453121af9c60",
    role="RUNNER_ROLE_ADMIN",
    runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(policy.policy)
{
  "policy": {
    "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "role": "RUNNER_ROLE_UNSPECIFIED"
  }
}
Returns Examples
{
  "policy": {
    "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "role": "RUNNER_ROLE_UNSPECIFIED"
  }
}