Gå til indholdet
Sursa Developers

Objekter

ApiKeyUpdate

Ændringer af nøglen. Felter, der ikke angives, forbliver uændrede, og data_profile er valgfrit. En tom liste scopes betyder scopes efter rolle, tomme collection_ids og allowed_cidrs betyder ingen begrænsning, og expires_at sat til null betyder, at nøglen ikke udløber. En nøgle, der selv er begrænset til samlinger, kan ikke fjerne eller udvide en begrænsning til samlinger (collection_ids).

Felter

  • data_profilestring

    Nøglens nye dataprofil. En dataprofil gælder ikke for rollen admin, så en anden profil end full returnerer 400 api_keys.data_profile_not_applicable for en nøgle med denne rolle.

  • scopesarray of ApiKeyScope

    Nøglens scopes. Scopet system udstedes ikke via API’et.

  • collection_idsarray of integer

    Begrænser nøglen til disse samlinger. En tom liste betyder ingen begrænsning. En kaldende nøgle, der selv er begrænset til samlinger, ser og ændrer kun nøgler i sine samlinger (andre nøgler returnerer 404 api_keys.not_found) og kan kun angive en ikke-tom liste over sine egne samlinger. En tom liste eller en samling uden for dens liste returnerer 400 api_keys.invalid_collections. Uden dette felt forbliver nøglens samlinger uændrede.

    items ≤ 100

  • allowed_cidrsarray of string

    Netværk, nøglen må bruges fra.

    items ≤ 50

  • expires_atstring (date-time) | null

    Udløbstidspunkt (i fremtiden). null betyder, at nøglen ikke udløber.

Bruges af