Get user agent

zones.user_agents.retrieve(, ) -> UserAgent

GET/zones/{zoneId}/user-agents/{id}

Returns details of a specific user agent by user agent ID

ParametersExpand Collapse

zone_id: str

id: str

ReturnsExpand Collapse

class UserAgent: …

A User Agent represents a user agent (browser, desktop app, CLI tool) that can initiate user sessions via OAuth 2.0 Dynamic Client Registration.

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

Get user agent

from keycardai_api import KeycardAPI

client = KeycardAPI()
user_agent = client.zones.user_agents.retrieve(
    id="id",
    zone_id="zoneId",
)
print(user_agent.id)

{
  "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"
}

Returns Examples

{
  "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"
}