Przejdź do treści
Sursa Developers

Obiekty

ApiKeyUpdate

Zmiany klucza. Pola, których nie przekazano, pozostają bez zmian, a data_profile jest opcjonalne. Pusta lista scopes oznacza zakresy według roli, puste collection_ids i allowed_cidrs – brak ograniczenia, a expires_at ustawione na null – klucz, który nie wygasa. Klucz, który sam jest ograniczony do kolekcji, nie może usunąć ani poszerzyć ograniczenia do kolekcji (collection_ids).

Pola

  • data_profilestring

    Nowy profil dostępu klucza. Profil dostępu nie ma zastosowania do roli admin, dlatego dla klucza administratora profil inny niż full zwraca 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Zakresy klucza. Zakresu system nie można wydać przez API.

  • collection_idsarray of integer

    Ogranicza klucz do tych kolekcji. Pusta lista oznacza brak ograniczenia. Klucz wywołujący, który sam jest ograniczony do kolekcji, widzi i zmienia tylko klucze w swoich kolekcjach (pozostałe klucze zwracają 404 api_keys.not_found) i może ustawić tylko niepustą listę własnych kolekcji. Pusta lista lub kolekcja spoza jego listy zwraca 400 api_keys.invalid_collections. Bez tego pola kolekcje klucza pozostają bez zmian.

    items ≤ 100

  • allowed_cidrsarray of string

    Sieci, z których można używać klucza.

    items ≤ 50

  • expires_atstring (date-time) | null

    Czas wygaśnięcia (w przyszłości). null oznacza, że klucz nie wygasa.

Używane przez