Get user agent

client.Zones.UserAgents.Get(ctx, id, query) (*UserAgent, error)

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

Returns details of a specific user agent by user agent ID

ParametersExpand Collapse

id string

query ZoneUserAgentGetParams

ZoneID param.Field[string]

Zone ID

ReturnsExpand Collapse

type UserAgent struct{…}

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

CreatedAt Time

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

OrganizationID string

Organization that owns this user agent

Slug string

URL-safe identifier, unique within the zone

minLength1

maxLength63

UpdatedAt Time

Entity update timestamp

formatdate-time

ZoneID string

Zone this user agent belongs to

Get user agent

package main

import (
  "context"
  "fmt"

  "github.com/keycardai/keycard-go"
)

func main() {
  client := keycard.NewClient(

  )
  userAgent, err := client.Zones.UserAgents.Get(
    context.TODO(),
    "id",
    keycard.ZoneUserAgentGetParams{
      ZoneID: "zoneId",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}