List user agents

client.Zones.UserAgents.List(ctx, zoneID, query) (*ZoneUserAgentListResponse, error)

GET/zones/{zoneId}/user-agents

Returns a list of user agents in the specified zone. User agents represent client software (browsers, desktop apps, CLI tools) registered via OAuth 2.0 Dynamic Client Registration.

ParametersExpand Collapse

zoneID string

query ZoneUserAgentListParams

After param.Field[string]optional

Cursor for forward pagination

minLength1

maxLength255

Before param.Field[string]optional

Cursor for backward pagination

minLength1

maxLength255

Expand param.Field[ZoneUserAgentListParamsExpandUnion]optional

type ZoneUserAgentListParamsExpandString string

type ZoneUserAgentListParamsExpandArray []string

Limit param.Field[int64]optional

Maximum number of items to return

minimum1

maximum100

ReturnsExpand Collapse

type ZoneUserAgentListResponse struct{…}

Items []UserAgent

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

Pagination ZoneUserAgentListResponsePagination

Cursor-based pagination metadata

AfterCursor string

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

BeforeCursor string

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

TotalCount int64optional

Total number of items matching the query. Only included when expand[]=total_count is requested.

List user agents

package main

import (
  "context"
  "fmt"

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

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

  )
  userAgents, err := client.Zones.UserAgents.List(
    context.TODO(),
    "zoneId",
    keycard.ZoneUserAgentListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", userAgents.Items)
}

{
  "items": [
    {
      "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"
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}

Returns Examples

{
  "items": [
    {
      "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"
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}