Hoppa till innehållet
Sursa Developers

Objekt

ApiKeyUpdate

Ändringar av nyckeln. Fält som inte skickas förblir oförändrade, och data_profile är valfritt. En tom lista scopes betyder omfång enligt rollen, tomma collection_ids och allowed_cidrs betyder ingen begränsning, och expires_at satt till null betyder att nyckeln inte upphör att gälla. En nyckel som själv är begränsad till samlingar kan inte ta bort eller vidga en begränsning till samlingar (collection_ids).

Fält

  • data_profilestring

    Nyckelns nya dataprofil. En dataprofil gäller inte rollen admin, så en annan profil än full returnerar 400 api_keys.data_profile_not_applicable för en nyckel med den rollen.

  • scopesarray of ApiKeyScope

    Nyckelns omfång. Omfånget system utfärdas inte via API:et.

  • collection_idsarray of integer

    Begränsar nyckeln till dessa samlingar. En tom lista betyder ingen begränsning. En anropande nyckel som själv är begränsad till samlingar ser och ändrar bara nycklar i sina samlingar (andra nycklar returnerar 404 api_keys.not_found) och kan bara ange en lista med sina egna samlingar som inte är tom. En tom lista eller en samling utanför dess lista returnerar 400 api_keys.invalid_collections. Utan det här fältet förblir nyckelns samlingar oförändrade.

    items ≤ 100

  • allowed_cidrsarray of string

    Nätverk som nyckeln får användas från.

    items ≤ 50

  • expires_atstring (date-time) | null

    Utgångstid (i framtiden). null betyder att nyckeln inte upphör att gälla.

Används av