Skip to content
API Reference

User Agents

User Agents

List user agents
client.zones.userAgents.list(stringzoneID, UserAgentListParams { after, before, expand, limit } query?, RequestOptionsoptions?): UserAgentListResponse { items, pagination }
GET/zones/{zoneId}/user-agents
Get user agent
client.zones.userAgents.retrieve(stringid, UserAgentRetrieveParams { zoneId } params, RequestOptionsoptions?): UserAgent { id, created_at, identifier, 5 more }
GET/zones/{zoneId}/user-agents/{id}
ModelsExpand Collapse
UserAgent { id, created_at, identifier, 5 more }

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: string

Unique identifier of the user agent

created_at: string

Entity creation timestamp

formatdate-time
identifier: string

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

name: string

Human-readable name

minLength1
maxLength255
organization_id: string

Organization that owns this user agent

slug: string

URL-safe identifier, unique within the zone

minLength1
maxLength63
updated_at: string

Entity update timestamp

formatdate-time
zone_id: string

Zone this user agent belongs to