Skip to content
Kindgi

Read an API key

View as Markdown
GET
/v1/tokens/{tokenId}
curl --request GET \
  --url https://example.com/v1/tokens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Never returns the secret. A tenant admin reads any key; anyone else only their own (someone else’s reads as missing).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tokenId
required
string format: uuid

ApiTokenId — opaque branded string (a UUID).

Responses

Section titled “Responses”

200

Section titled “200”

The key.

Media typeapplication/json

An API key. Never includes the secret. principal is whom it acts for; absent on a key that is a service account of its own (service_account:<tokenId>), as keys minted before principals are.

object
tokenId
required
string format: uuid
principal

Whom an API key acts for: a person, or a service account.

object
kind
required
string
Allowed values: user service-account
id
required

The user id, or the service account id.

string
>= 1 characters
role
required

The most the key may do, under its principal’s grants: an admin key may administer the tenant when its principal is a tenant admin; a member key takes no admin action on the tenant, whoever it’s for; below it, its principal’s roles hold (a project admin’s member key administers that project).

string
Allowed values: admin member
capabilities
required

Framework capabilities the key carries (env:write, secrets:write, …). A caller can only grant capabilities it holds.

Array<string>
label
string
projectId

The project the key is limited to.

string format: uuid
createdBy

Who minted it: user:<id> or service_account:<id>.

string
createdAt
required
string format: date-time
expiresAt
string format: date-time
revokedAt

Set once revoked; a revoked key never authenticates again.

string format: date-time
lastUsedAt

When the key last authenticated a request (updated at most once a minute).

string format: date-time
Example
{
  "principal": {
    "kind": "user"
  },
  "role": "admin"
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Section titled “403”

A caller with no keys of its own that is not a tenant admin.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No token with that id that the caller may see.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also