Preskočiť na obsah
Sursa Developers

Objekty

ApiKeyUpdate

Zmeny kľúča. Polia, ktoré sa neodovzdajú, zostanú bez zmeny, a data_profile je nepovinné. Prázdny zoznam scopes znamená rozsahy podľa roly, prázdne collection_ids a allowed_cidrs znamenajú bez obmedzenia a expires_at nastavené na null znamená, že platnosť kľúča nevyprší. Kľúč, ktorý je sám obmedzený na kolekcie, nemôže obmedzenie na kolekcie (collection_ids) odstrániť ani rozšíriť.

Polia

  • data_profilestring

    Nový dátový profil kľúča. Dátový profil sa na rolu admin nevzťahuje, preto pri kľúči s rolou administrátora iný profil ako full vráti 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Rozsahy kľúča. Rozsah system sa cez API nevydáva.

  • collection_idsarray of integer

    Obmedzí kľúč na tieto kolekcie. Prázdny zoznam znamená bez obmedzenia. Volajúci kľúč, ktorý je sám obmedzený na kolekcie, vidí a mení len kľúče vo svojich kolekciách (ostatné kľúče vrátia 404 api_keys.not_found) a môže nastaviť len neprázdny zoznam svojich vlastných kolekcií. Prázdny zoznam alebo kolekcia mimo jeho zoznamu vráti 400 api_keys.invalid_collections. Bez tohto poľa zostanú kolekcie kľúča bez zmeny.

    items ≤ 100

  • allowed_cidrsarray of string

    Siete, z ktorých možno kľúč používať.

    items ≤ 50

  • expires_atstring (date-time) | null

    Čas vypršania platnosti (v budúcnosti). null znamená, že platnosť kľúča nevyprší.

Používa