tokenInfoResponse
No description available in the specification.
Fields
Section titled “Fields”| Field | Type | Required | Description |
|---|---|---|---|
key_id | string | yes | Public key id (the HASH part of the token). |
token_l4 | string | yes | Last 4 characters of the token (display id). |
permissions | string[] | yes | Granted permissions; null = legacy key with full access. |
scope | string | yes | Capability scope of the key; null = ordinary customer key. A non-null scope (e.g. acme-dns-challenge) marks a special-purpose platform credential that is restricted to a fixed set of operations. |
customer_id | integer | yes | RF user id the key is scoped to. |
token_kind | string | no | Where the authorisation came from. api_key is a classic regfish API key; oauth is an access token issued by the regfish authorization server. (api_key, oauth) |
audience | string | no | For OAuth tokens: the resource the token was issued for (RFC 8707). A resource server must check that this names itself and reject tokens minted for anything else, even valid ones. null for API keys, which are not audience-bound. |
Example
Section titled “Example”{ "key_id": "string", "token_l4": "string", "permissions": [ "string" ], "scope": "string", "customer_id": 0, "token_kind": "api_key", "audience": "string"}