Referencja obiektu tokenu

Gdy tworzysz lub odczytujesz klucz API przez konsolę lub REST API, brama zwraca obiekt tokenu — rekord JSON, który trzyma tożsamość klucza, jego limity i dwa załączniki polityk, które rządzą jego ruchem. Ta strona to referencja pole po polu dla tego obiektu: co każde pole oznacza, jaki ma typ i jakie wartości wartownicze (0, -1) niosą szczególne znaczenie. Po dlaczego za tymi polami — model minimalnych uprawnień — zacznij od przeglądu kluczy o ograniczonym zakresie. Ta strona to tabela odnośników, którą trzymasz otwartą, gdy skryptujesz tworzenie kluczy.

1. Referencja obiektu tokenu w skrócie

Świeżo utworzony klucz dla zaplanowanego agenta do streszczania wygląda tak:

{
  "id": 4812,
  "name": "support-summarizer-prod",
  "status": 1,
  "key": "sk-orca-a1b2****yz90",
  "created_time": 1733616000,
  "accessed_time": 1733702400,
  "expired_time": -1,
  "unlimited_quota": false,
  "remain_quota": 500000,
  "used_quota": 12340,
  "model_limits_enabled": true,
  "model_limits": "openai/gpt-4o-mini",
  "credit_limit_usd": 25,
  "allow_ips": "203.0.113.7",
  "environment": "prod",
  "guardrail_id": 17,
  "firewall_policy_id": 9,
  "is_firewall_gateway": false,
  "group": "default"
}

Pole key jest zamaskowane przy każdym odczycie — widzisz prefiks marki i ostatnie cztery znaki, nigdy pełny sekret. Plaintext jest pokazywany raz, przy tworzeniu. Zobacz Maskowanie klucza.

2. Pola tożsamości i cyklu życia

Te opisują, który to klucz i gdzie jest w swoim cyklu życia.

id — number

Stabilny identyfikator numeryczny klucza. Użyj go, by zaadresować klucz w wywołaniach aktualizacji i usunięcia. Tylko do odczytu.

name — string

Czytelna dla człowieka etykieta klucza, pokazywana w konsoli i w logach. Nazywaj klucze po agencie, który je trzyma — jeden klucz, jeden agent.

status — number

Stan włączony / wyłączony. 1 oznacza aktywny; wyłączony klucz jest odrzucany przy uwierzytelnianiu, nie będąc usuniętym, więc możesz wstrzymać klucz i włączyć go ponownie.

key — string (zamaskowany)

Sekret na okaziciela, zwracany zamaskowany (sk-orca-…****…). Pełna wartość jest pokazywana tylko raz, przy tworzeniu. Traktuj go jak hasło.

created_time / accessed_time — number

Uniksowe znaczniki czasu (sekundy) dla momentu wybicia klucza i momentu, gdy ostatnio obsłużył żądanie. accessed_time to twój sygnał dla nieświeżego lub nieużywanego klucza wartego unieważnienia.

expired_time — number

Bezwzględne wygaśnięcie jako uniksowy znacznik czasu. Wartownik -1 oznacza, że klucz nigdy nie wygasa. Ustaw prawdziwy znacznik czasu, by klucz auto-wygasał — właściwa domyślna dla przebiegów CI i efemerycznych agentów. Zobacz Klucze wygasające.

3. Pola wydatków i kwoty

Te ograniczają, ile klucz może zużyć, zanim przestanie działać.

Pole	Typ	Znaczenie
`credit_limit_usd`	number	Limit wydatków w całym okresie życia w USD. `0` = nieograniczone.
`unlimited_quota`	boolean	Gdy `true`, klucz nie jest mierzony wobec salda kwoty.
`remain_quota`	number	Kwota pozostała na kluczu.
`used_quota`	number	Kwota zużyta dotąd.

Klucz z credit_limit_usd: 0 i unlimited_quota: true i expired_time: -1 nie ma pułapu wydatków i nigdy nie wygasa — najgorszy promień rażenia, gdy wycieknie. Zobacz nieograniczone vs ograniczone dla tego, kiedy klucz bez limitu jest uzasadniony.

4. Pola zasięgu i zakresu

Te ograniczają, do czego klucz może sięgnąć — które modele, z których adresów.

model_limits / model_limits_enabled

model_limits to lista modeli, które klucz może wywoływać; model_limits_enabled to przełącznik włącz/wyłącz. Z włączonym limitem wywołanie dowolnego modelu spoza listy jest odrzucane zanim opuści bramę — agent nie może przełączyć się na droższy lub potężniejszy model. Zobacz Limity modeli.

allow_ips — string

Lista dozwolonych IP / CIDR, jeden wpis na linię. Żądanie okazujące klucz z dowolnego niewypisanego adresu jest odrzucane na warstwie uwierzytelniania; pusta wartość oznacza, że wszystkie adresy są dozwolone. Zobacz Listę dozwolonych IP.

environment — string

Dowolna etykieta wdrożenia (prod, staging, dev lub cokolwiek wybierzesz) do organizowania kluczy i filtrowania logów. Czysto organizacyjna — nie zmienia egzekwowania. Zobacz Środowiska.

group — string

Grupa routingu, przez którą klucz rozwiązuje modele. Pozostaw ją na domyślnej przestrzeni roboczej, chyba że dostałeś konkretną grupę.

5. Pola załączników polityk

Dwa najpotężniejsze pola na kluczu. Każde wiąże klucz z polityką w zakresie przestrzeni roboczej, która rządzi jego ruchem — zmień politykę, a każdy klucz do niej dołączony podchwytuje zmianę przy następnym żądaniu, bez ponownego wdrożenia.

Pole	Typ	Wiąże klucz z
`guardrail_id`	number	Guardrailem treści, który prześwietla tekst żądania i odpowiedzi.
`firewall_policy_id`	number	Polityką firewalla, która rządzi wywołaniami narzędzi, które klucz wystawia.
`is_firewall_gateway`	boolean	Oznacza klucz jako token w zakresie gateway dla tras Firewall MCP / evaluate (nie do inferencji).

Wartownikiem dla obu załączników jest 0 (niedołączone). Ale dwie płaszczyzny rozwiązują wyłączony załącznik inaczej:

Wyłączony guardrail_id jest przełącznikiem wyłączającym — klucz dostaje żaden guardrail, bez fallbacku do domyślnego przestrzeni roboczej.
Wyłączony firewall_policy_id wraca do domyślnej polityki firewalla przestrzeni roboczej.

Pełna kolejność rozwiązywania żyje na Powiązanie polityk oraz Zakres i klucze.

is_firewall_gateway: true wybija klucz w zakresie gateway wyłącznie dla tras /api/v1/firewall/* — nigdy nie umieszczaj go na kluczu inferencji. Włączenie flagi oraz odczyt plaintextu klucza gateway oba wymagają Admin+.

6. Ustawianie tych pól

Każde pole powyżej jest konfigurowane w edytorze klucza w konsoli (/console/token) — nie przez klucz relay. Tworzenie lub edycja klucza wymaga roli Developer lub wyższej; flaga is_firewall_gateway wymaga Admin+.

Obiekt tokenu to powierzchnia konfiguracji. Plaintext klucza (sk-orca-…) to to, co twój agent okazuje przy wywołaniach relay /v1/*. Skonfiguruj klucz w konsoli; agent zawsze widzi tylko sekret.

Konkretny klucz o minimalnych uprawnieniach — ustawiony w edytorze, odczytany z powrotem jako obiekt powyżej — ogranicza jeden model, jeden zakres źródłowego IP, tygodniowy pułap w USD, wygaśnięcie oraz jeden guardrail plus jedną politykę firewalla. Jeśli agent, który go trzyma, zostanie przejęty przez prompt injection, promień rażenia zatrzymuje się dokładnie na tych granicach.

7. Powiązane referencje

Przegląd kluczy o ograniczonym zakresie

Model minimalnych uprawnień i centrum dla każdego pola klucza.

Powiązanie polityk

Jak guardrail_id i firewall_policy_id rozwiązują się do aktywnej polityki.

Kwota, limit i wygaśnięcie

credit_limit_usd, expired_time oraz pola kwoty w głębi.

Lista kontrolna minimalnych uprawnień

Przepuść każdy klucz przez ten sam przebieg utwardzania.

Nowy w modelu? Przeczytaj Zakres, klucze, polityki i przestrzenie robocze dla tego, jak obiekt tokenu pasuje do hierarchii przestrzeń robocza → polityka → klucz.

​1. Referencja obiektu tokenu w skrócie

​2. Pola tożsamości i cyklu życia

​3. Pola wydatków i kwoty

​4. Pola zasięgu i zakresu

​5. Pola załączników polityk

​6. Ustawianie tych pól

​7. Powiązane referencje

Przegląd kluczy o ograniczonym zakresie

Powiązanie polityk

Kwota, limit i wygaśnięcie

Lista kontrolna minimalnych uprawnień

1. Referencja obiektu tokenu w skrócie

2. Pola tożsamości i cyklu życia

3. Pola wydatków i kwoty

4. Pola zasięgu i zakresu

5. Pola załączników polityk

6. Ustawianie tych pól

7. Powiązane referencje