The admin key object

⚠️

Preview — this feature is being built; the design below is the spec.

The admin_key object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "adminkey_01JCC2E4G6J8L0N2Q4S6",
  "type": "admin_key",
  "name": "terraform-org",
  "prefix": "sk_admin_7d3e",
  "status": "active",
  "created_by": {
    "id": "user_01J9X8Z6B4D2F0H8K6M4",
    "email": "ops@example.com",
    "role": "owner"
  },
  "allowed_ips": [
    "203.0.113.0/24"
  ],
  "created_at": "2026-11-01T09:00:00Z",
  "last_used_at": "2026-11-05T02:00:13Z"
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `admin_key`.
`name`	string	Name shown in the Console and in reports.
`prefix`	string	First characters of the secret, to match it against logs.
`status`	string	`active` or `inactive`.
`created_by`	object	The member whose current role the key acts with.
`allowed_ips`	array	CIDR ranges the key may be used from; empty means anywhere.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).
`last_used_at`	string	Last time it was used, or `null`.

Returned by

activity agent

Was this page helpful?