Objets

ApiKeyCreate

Champs

• namestringobligatoire

  length ≥ 1, length ≤ 64

• rolestring

  Par défaut : "editor"

• data_profilestring | null

  Profil de données de la clé. Sans ce champ, la clé reçoit le profil par défaut de l’organisation. Un profil de données ne s’applique pas au rôle admin. Une clé d’administrateur voit toutes les données de l’organisation, et un profil autre que full renvoie 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Date d’expiration de la clé (ISO 8601, dans le futur). null ou l’absence de valeur signifie que la clé n’expire pas.

• scopesarray of ApiKeyScope | null

  Portées de la clé. En leur absence, les portées suivent le rôle : admin reçoit read, write, admin ; editor et verifier reçoivent read, write ; viewer reçoit read. La portée system n’est délivrée que par l’administrateur de l’installation. Les portées fines resource:action (ApiKeyScope) sont aussi acceptées ; les anciennes portées read, write et admin se développent en ensembles de portées.

• collection_idsarray of integer | null

  Limite la clé à ces collections de l’organisation. Les fiches, la recherche, les réponses et les événements ne fonctionnent que dans ces collections, en plus du rôle et du profil de données. L’absence de valeur ou une liste vide signifie aucune restriction. Si la clé appelante est elle-même limitée à des collections, la nouvelle clé ne peut porter que sur ses collections. Sans ce champ, la nouvelle clé reçoit les collections de la clé appelante. Une liste vide ou une collection hors de sa liste renvoie 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Réseaux depuis lesquels la clé peut être utilisée, par exemple 10.0.0.0/8 ou 2001:db8::/32. Une adresse seule est un réseau d’une seule adresse. Une requête depuis une autre adresse renvoie 403 api_keys.ip_not_allowed. L’absence de valeur signifie aucune restriction.

  items ≤ 50

Utilisé par

• POST/v1/api-keysCréer une clé API