Hopp til innholdet
Sursa Developers

Objekter

ApiKeyUpdate

Endringer i nøkkelen. Felt som ikke sendes, forblir uendret, og data_profile er valgfritt. En tom liste scopes betyr scopes etter rolle, tomme collection_ids og allowed_cidrs betyr ingen begrensning, og expires_at satt til null betyr at nøkkelen ikke utløper. En nøkkel som selv er begrenset til samlinger, kan ikke fjerne eller utvide en begrensning til samlinger (collection_ids).

Felt

  • data_profilestring

    Nøkkelens nye dataprofil. En dataprofil gjelder ikke for rollen admin, så en annen profil enn full returnerer 400 api_keys.data_profile_not_applicable for en nøkkel med denne rollen.

  • scopesarray of ApiKeyScope

    Nøkkelens scopes. Scopet system utstedes ikke via API-et.

  • collection_idsarray of integer

    Begrenser nøkkelen til disse samlingene. En tom liste betyr ingen begrensning. En nøkkel som kaller og selv er begrenset til samlinger, ser og endrer bare nøkler i sine samlinger (andre nøkler returnerer 404 api_keys.not_found) og kan bare angi en ikke-tom liste med sine egne samlinger. En tom liste eller en samling utenfor listen dens returnerer 400 api_keys.invalid_collections. Uten dette feltet forblir samlingene til nøkkelen uendret.

    items ≤ 100

  • allowed_cidrsarray of string

    Nettverk nøkkelen kan brukes fra.

    items ≤ 50

  • expires_atstring (date-time) | null

    Utløpstidspunkt (i framtiden). null betyr at nøkkelen ikke utløper.

Brukes av