Vai al contenuto
Sursa Developers

Oggetti

ApiKeyUpdate

Modifiche alla chiave. I campi non passati restano invariati, e data_profile è facoltativo. Un elenco scopes vuoto indica gli ambiti secondo il ruolo, collection_ids e allowed_cidrs vuoti indicano nessuna limitazione, e expires_at impostato a null indica che la chiave non scade. Una chiave a sua volta limitata a determinate raccolte non può rimuovere né ampliare una limitazione alle raccolte (collection_ids).

Campi

  • data_profilestring

    Nuovo profilo dati della chiave. Un profilo dati non si applica al ruolo admin, quindi per una chiave di amministratore un profilo diverso da full restituisce 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Ambiti della chiave. L’ambito system non viene concesso tramite l’API.

  • collection_idsarray of integer

    Limita la chiave a queste raccolte. Un elenco vuoto indica nessuna limitazione. Una chiave che effettua la chiamata ed è a sua volta limitata a determinate raccolte vede e modifica solo le chiavi nelle sue raccolte (le altre chiavi restituiscono 404 api_keys.not_found) e può impostare solo un elenco non vuoto delle proprie raccolte. Un elenco vuoto o una raccolta fuori dal suo elenco restituiscono 400 api_keys.invalid_collections. Senza questo campo, le raccolte della chiave restano invariate.

    items ≤ 100

  • allowed_cidrsarray of string

    Reti da cui la chiave può essere usata.

    items ≤ 50

  • expires_atstring (date-time) | null

    Momento di scadenza (nel futuro). null indica che la chiave non scade.

Usato da