Siirry sisältöön
Sursa Developers

Objektit

ApiKeyUpdate

Avaimen muutokset. Kentät, joita ei välitetä, pysyvät ennallaan, ja data_profile on valinnainen. Tyhjä scopes-luettelo tarkoittaa roolin mukaisia käyttöalueita, tyhjät collection_ids ja allowed_cidrs tarkoittavat, ettei rajausta ole, ja null-arvoon asetettu expires_at tarkoittaa, että avain ei vanhene. Avain, joka on itse rajattu kokoelmiin, ei voi poistaa kokoelmarajausta eikä laajentaa sitä (collection_ids).

Kentät

  • data_profilestring

    Avaimen uusi dataprofiili. Dataprofiili ei koske admin-roolia, joten jos avaimella on tämä rooli, muu profiili kuin full palauttaa 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Avaimen käyttöalueet. Käyttöaluetta system ei myönnetä API:n kautta.

  • collection_idsarray of integer

    Rajaa avaimen näihin kokoelmiin. Tyhjä luettelo tarkoittaa, ettei rajausta ole. Kutsuva avain, joka on itse rajattu kokoelmiin, näkee ja muuttaa vain avaimia, jotka ovat sen kokoelmissa (muut avaimet palauttavat 404 api_keys.not_found), ja voi asettaa vain ei-tyhjän luettelon omista kokoelmistaan. Tyhjä luettelo tai kokoelma sen luettelon ulkopuolelta palauttaa 400 api_keys.invalid_collections. Ilman tätä kenttää avaimen kokoelmat pysyvät ennallaan.

    items ≤ 100

  • allowed_cidrsarray of string

    Verkot, joista avainta voi käyttää.

    items ≤ 50

  • expires_atstring (date-time) | null

    Vanhenemisaika (tulevaisuudessa). null tarkoittaa, että avain ei vanhene.

Käytössä