Obiekty

ApiKeyCreate

Pola

• namestringwymagane

  length ≥ 1, length ≤ 64

• rolestring

  Domyślnie: "editor"

• data_profilestring | null

  Profil dostępu klucza. Bez niego klucz otrzymuje domyślny profil organizacji. Profil dostępu nie ma zastosowania do roli admin. Klucz administratora widzi wszystkie dane organizacji, a profil inny niż full zwraca 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Czas wygaśnięcia klucza (ISO 8601, w przyszłości). null lub brak wartości oznacza, że klucz nie wygasa.

• scopesarray of ApiKeyScope | null

  Zakresy klucza. Jeśli ich brak, zakresy wynikają z roli: admin dostaje read, write, admin; editor i verifier – read, write; viewer – read. Zakres system wydaje tylko administrator instalacji. Przyjmowane są też szczegółowe zakresy resource:action (ApiKeyScope); wcześniejsze read, write i admin rozwijają się w zestawy zakresów.

• collection_idsarray of integer | null

  Ogranicza klucz do tych kolekcji organizacji. Karty, wyszukiwanie, odpowiedzi i zdarzenia działają tylko w nich, oprócz ograniczeń roli i profilu dostępu. Brak wartości lub pusta lista oznacza brak ograniczenia. Jeśli klucz wywołujący sam jest ograniczony do kolekcji, nowy klucz może należeć tylko do jego kolekcji. Bez tego pola nowy klucz otrzymuje kolekcje klucza wywołującego. Pusta lista lub kolekcja spoza jego listy zwraca 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Sieci, z których można używać klucza, np. 10.0.0.0/8 lub 2001:db8::/32. Pojedynczy adres to sieć z jednym adresem. Żądanie z innego adresu zwraca 403 api_keys.ip_not_allowed. Brak wartości oznacza brak ograniczenia.

  items ≤ 50

Używane przez

• POST/v1/api-keysTworzenie klucza API