Get Cluster Access Policy

The organisation cluster access policy: the role the user who creates or imports a cluster receives on it, the highest role any cluster access grant may carry, the longest a grant above view may last, and the role from which grants need a reason. An organisation that has not set one reads the default (creator receives cluster-admin, no ceiling, no bounds) with is_configured false. Readable with kube_access.manage, kube_access.policy or kube_access.elevate (a break-glass holder reads the bounds it is held to). organisation_id and organisation_name name the organisation read: a token reads its own unless X-Ankra-Organisation-Id names another, so check them before reporting another organisation’s policy.

GET /api/v1/org/cluster-access-policy

Get Cluster Access Policy

Python

import requests

url = "https://platform.ankra.app/api/v1/org/cluster-access-policy"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "policy": {
    "creator_grant_role": "none",
    "max_grant_role": "view",
    "elevated_max_ttl_seconds": 15768030,
    "require_reason_from_role": "view",
    "is_configured": true
  },
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_name": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Response

200

application/json

Successful Response

policy · ClusterAccessPolicy · object · required

Show child attributes

organisation_id · string<uuid> · required

The organisation this policy belongs to: the one the request selected (a token's own unless X-Ankra-Organisation-Id names another, or the session's current organisation).

organisation_name · string | null · required

That organisation's name; null for an organisation without one.