User Agents

Get user agent

API Reference

Zones

User Agents

Get user agent

client.zones.userAgents.retrieve(, , ?): UserAgent { id, created_at, identifier, 5 more }

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

Returns details of a specific user agent by user agent ID

ParametersExpand Collapse

id: string

params: UserAgentRetrieveParams { zoneId }

zoneId: string

Zone ID

ReturnsExpand 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

Get user agent

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI();

const userAgent = await client.zones.userAgents.retrieve('id', { zoneId: 'zoneId' });

console.log(userAgent.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"
}