Přejít na obsah
Sursa Developers

Objekty

ApiKeyUpdate

Změny klíče. Nepředaná pole zůstávají beze změny a data_profile je nepovinné. Prázdný seznam scopes znamená rozsahy podle role, prázdné collection_ids a allowed_cidrs znamenají bez omezení a expires_at nastavené na null znamená, že platnost klíče nevyprší. Klíč, který je sám omezen na kolekce, nemůže omezení na kolekce (collection_ids) odstranit ani rozšířit.

Pole

  • data_profilestring

    Nový datový profil klíče. Datový profil se na roli admin nevztahuje, takže u klíče administrátora profil jiný než full vrací 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Rozsahy klíče. Rozsah system se přes API nevydává.

  • collection_idsarray of integer

    Omezí klíč na tyto kolekce. Prázdný seznam znamená bez omezení. Volající klíč, který je sám omezen na kolekce, vidí a mění jen klíče ve svých kolekcích (ostatní klíče vracejí 404 api_keys.not_found) a může nastavit jen neprázdný seznam svých vlastních kolekcí. Prázdný seznam nebo kolekce mimo jeho seznam vrací 400 api_keys.invalid_collections. Bez tohoto pole zůstávají kolekce klíče beze změny.

    items ≤ 100

  • allowed_cidrsarray of string

    Sítě, ze kterých lze klíč používat.

    items ≤ 50

  • expires_atstring (date-time) | null

    Čas vypršení platnosti (v budoucnosti). null znamená, že platnost klíče nevyprší.

Používá