List cluster access policy proposals

The organisation’s cluster access policy proposals, newest first (at most 20; is_capped says when more matched). status filters by the status a proposal reads as: a pending proposal past its expiry reads as expired. Readable with kube_access.manage, kube_access.policy or kube_access.elevate, like the policy itself. organisation_id and organisation_name name the organisation listed, so an empty listing still says whose it is.

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

List cluster access policy proposals

Python

import requests

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

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

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

print(response.text)

200

{
  "proposals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "proposed": {
        "creator_grant_role": "none",
        "max_grant_role": "view",
        "elevated_max_ttl_seconds": 15768030,
        "require_reason_from_role": "view"
      },
      "base": {
        "creator_grant_role": "none",
        "max_grant_role": "view",
        "elevated_max_ttl_seconds": 15768030,
        "require_reason_from_role": "view",
        "is_configured": true
      },
      "current": {
        "creator_grant_role": "none",
        "max_grant_role": "view",
        "elevated_max_ttl_seconds": 15768030,
        "require_reason_from_role": "view",
        "is_configured": true
      },
      "base_matches_current": true,
      "reason": "<string>",
      "proposed_by": {
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "principal": "<string>",
        "token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "token_name": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "decided_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "decided_at": "2023-11-07T05:31:56Z",
      "decision_note": "<string>",
      "apply_url": "<string>",
      "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organisation_name": "<string>"
    }
  ],
  "is_capped": 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

Query Parameters

status · enum<string>

Available options: pending, applied, dismissed, expired, superseded

Response

200

application/json

Successful Response

proposals · ClusterAccessPolicyProposal · object[] · required

Show child attributes

is_capped · boolean · required

organisation_id · string<uuid> · required

The organisation that was listed: 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.