Objets

ApiKeyUpdate

Modifications de la clé. Les champs non transmis restent inchangés, et data_profile est facultatif. Une liste scopes vide signifie des portées selon le rôle, des listes collection_ids et allowed_cidrs vides signifient aucune restriction, et expires_at à null signifie que la clé n’expire pas. Une clé elle-même limitée à des collections ne peut ni supprimer ni élargir une restriction aux collections (collection_ids).

Champs

data_profilestring
Nouveau profil de données de la clé. Un profil de données ne s’applique pas au rôle admin ; pour une clé d’administrateur, un profil autre que full renvoie donc 400 api_keys.data_profile_not_applicable.
scopesarray of ApiKeyScope
Portées de la clé. La portée system n’est pas délivrée via l’API.
collection_idsarray of integer
Limite la clé à ces collections. Une liste vide signifie aucune restriction. Une clé appelante elle-même limitée à des collections ne voit et ne modifie que les clés de ses collections (les autres clés renvoient 404 api_keys.not_found) et ne peut définir qu’une liste non vide de ses propres collections. Une liste vide ou une collection hors de sa liste renvoie 400 api_keys.invalid_collections. Sans ce champ, les collections de la clé restent inchangées.
items ≤ 100
allowed_cidrsarray of string
Réseaux depuis lesquels la clé peut être utilisée.
items ≤ 50
expires_atstring (date-time) | null
Date d’expiration (dans le futur). null signifie que la clé n’expire pas.

Utilisé par

PATCH/v1/api-keys/{key_id}Modifier une clé API