List user agents

zones.user_agents.list(, ) -> UserAgentListResponse

GET/zones/{zoneId}/user-agents

Returns a list of user agents in the specified zone. User agents represent client software (browsers, desktop apps, CLI tools) registered via OAuth 2.0 Dynamic Client Registration.

ParametersExpand Collapse

zone_id: str

after: Optional[str]

Cursor for forward pagination

minLength1

maxLength255

before: Optional[str]

Cursor for backward pagination

minLength1

maxLength255

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

Accepts one of the following:

Literal["total_count"]

List[Literal["total_count"]]

limit: Optional[int]

Maximum number of items to return

minimum1

maximum100

ReturnsExpand Collapse

class UserAgentListResponse: …

items: List[UserAgent]

id: str

Unique identifier of the user agent

created_at: datetime

Entity creation timestamp

formatdate-time

identifier: str

User agent identifier (serves as OAuth client_id). Format: ua:{sha256_hash}

name: str

Human-readable name

minLength1

maxLength255

organization_id: str

Organization that owns this user agent

slug: str

URL-safe identifier, unique within the zone

minLength1

maxLength63

updated_at: datetime

Entity update timestamp

formatdate-time

zone_id: str

Zone this user agent belongs to

pagination: Pagination

Cursor-based pagination metadata

after_cursor: Optional[str]

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

before_cursor: Optional[str]

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

total_count: Optional[int]

Total number of items matching the query. Only included when expand[]=total_count is requested.

List user agents

from keycardai_api import KeycardAPI

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

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "identifier": "identifier",
      "name": "x",
      "organization_id": "organization_id",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id"
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "identifier": "identifier",
      "name": "x",
      "organization_id": "organization_id",
      "slug": "slug",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "zone_id": "zone_id"
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}