KEkeycardai
User Agents

Get user agent

Changed on

Returns details of a specific user agent by user agent ID

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

Request

  • Base URL
    https://docs.keycard.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://docs.keycard.ai/zones/{zoneId}/user-agents/{id}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

idstring required

User agent ID

Response

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

idstring required

Unique identifier of the user agent

organization_idstring required

Organization that owns this user agent

zone_idstring required

Zone this user agent belongs to

slugstring required

URL-safe identifier, unique within the zone

identifierstring required

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

namestring required

Human-readable name

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Changes

  • d65d51379d93Revision changes
    • info

      added the non-success response with the status

  • d3d69f45bfedRevision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security iam_bearerAuth was removed from the API