Menu dokumentacji

API osobistych tokenów dostępu#

Zarządzanie PAT wymaga zakresu apps:manage. Wywołujący może utworzyć tylko zakresy dozwolone zarówno przez jego własny zestaw zakresów, jak i bieżącą rolę w organizacji.

Lista tokenów#

GET/pats

Zwraca metadane, takie jak identyfikator, nazwa, zakresy, twórca, czas utworzenia, opcjonalne wygaśnięcie i stan unieważnienia. Operacje listowania i pobierania nigdy nie zwracają sekretów.

Tworzenie tokenu#

POST/pats

Wyślij nazwę, żądane zakresy i opcjonalny termin wygaśnięcia. Odpowiedź zwraca 201, nagłówek Location i sekret pat_... dokładnie jeden raz.

json

{
  "name": "skycrane reporting",
  "scopes": ["query:read", "data:read"]
}

Natychmiast zapisz sekret. Supernova przechowuje jego skrót i nie może odzyskać oryginału. Nieprawidłowe treści zwracają 400 invalid_pat_parameters z nazwanym polem param, gdy jest to możliwe.

Unieważnianie tokenu#

DELETE/pats/{id}

Unieważnienie uniemożliwia PAT uwierzytelnianie przyszłych żądań. Nie anuluje zapytania ani wysyłki przyjętej już dla tego podmiotu; do aktywnej pracy użyj właściwego endpointu zasobu.

Identyfikator tokenu spoza organizacji wywołującego jest nieodróżnialny od nieznanego identyfikatora. Aby wymienić dane uwierzytelniające, utwórz zamiennik, zaktualizuj klientów, sprawdź GET /whoami, a następnie unieważnij stary PAT.