List policies in a zone

zones.policies.list(, ) -> PolicyListResponse

GET/zones/{zone_id}/policies

ParametersExpand Collapse

zone_id: str

after: Optional[str]

Return items after this cursor (forward pagination). Use after_cursor from a previous response. Mutually exclusive with before.

before: Optional[str]

Return items before this cursor (backward pagination). Use before_cursor from a previous response. Mutually exclusive with after.

expand: Optional[List[Literal["total_count"]]]

Opt-in to additional response fields

limit: Optional[int]

Maximum number of items to return

maximum100

minimum1

order: Optional[Literal["asc", "desc"]]

Sort direction. Default is desc (newest first).

Accepts one of the following:

"asc"

"desc"

sort: Optional[Literal["created_at"]]

Field to sort by.

x_api_version: Optional[str]

x_client_request_id: Optional[str]

formatuuid

ReturnsExpand Collapse

class PolicyListResponse: …

items: List[Policy]

id: str

created_at: datetime

formatdate-time

created_by: str

name: str

owner_type: Literal["platform", "customer"]

Who manages this policy:

"platform" — managed by the Keycard platform (system policies).
"customer" — managed by the tenant (custom policies).

Accepts one of the following:

"platform"

"customer"

updated_at: datetime

formatdate-time

zone_id: str

archived_at: Optional[datetime]

formatdate-time

description: Optional[str]

latest_version: Optional[int]

Human-readable version number of the latest version (e.g., 1, 2, 3)

latest_version_id: Optional[str]

updated_by: Optional[str]

pagination: Pagination

after_cursor: Optional[str]

Cursor of the last item on the current page. Pass to after for the next page. Null when there is no next page.

before_cursor: Optional[str]

Cursor of the first item on the current page. Pass to before for the previous page. Null when there is no previous page.

total_count: Optional[int]

Total number of items matching the current filters. Only included when expand=total_count is requested.

List policies in a zone

from keycardai_api import KeycardAPI

client = KeycardAPI()
policies = client.zones.policies.list(
    zone_id="zone_id",
)
print(policies.items)

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "name": "name",
      "owner_type": "platform",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "latest_version": 0,
      "latest_version_id": "latest_version_id",
      "updated_by": "updated_by"
    }
  ],
  "pagination": {
    "after_cursor": "after_cursor",
    "before_cursor": "before_cursor",
    "total_count": 0
  }
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "name": "name",
      "owner_type": "platform",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "latest_version": 0,
      "latest_version_id": "latest_version_id",
      "updated_by": "updated_by"
    }
  ],
  "pagination": {
    "after_cursor": "after_cursor",
    "before_cursor": "before_cursor",
    "total_count": 0
  }
}