Objectes

ApiKeyCreate

Camps

• namestringobligatori

  length ≥ 1, length ≤ 64

• rolestring

  Per defecte: "editor"

• data_profilestring | null

  Perfil de dades de la clau. Sense aquest camp, la clau rep el perfil per defecte de l’organització. Un perfil de dades no s’aplica al rol admin. Una clau d’administrador veu totes les dades de l’organització, i un perfil diferent de full retorna 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Moment de caducitat de la clau (ISO 8601, en el futur). null o cap valor vol dir que la clau no caduca.

• scopesarray of ApiKeyScope | null

  Àmbits de la clau. Si no s’indiquen, els àmbits depenen del rol: admin rep read, write, admin; editor i verifier reben read, write; viewer rep read. L’àmbit system només el concedeix l’administrador de la instal·lació. També s’accepten àmbits detallats resource:action (ApiKeyScope); els anteriors read, write i admin s’amplien en conjunts d’àmbits.

• collection_idsarray of integer | null

  Limita la clau a aquestes col·leccions de l’organització. Les entrades, la cerca, les respostes i els esdeveniments només funcionen dins d’aquestes col·leccions, a més del rol i del perfil de dades. Cap valor o una llista buida vol dir sense restricció. Si la clau que fa la crida està limitada a col·leccions, la clau nova només pot ser dins de les seves col·leccions. Sense aquest camp, la clau nova rep les col·leccions de la clau que fa la crida. Una llista buida o una col·lecció fora de la seva llista retorna 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Xarxes des de les quals es pot fer servir la clau, com ara 10.0.0.0/8 o 2001:db8::/32. Una sola adreça és una xarxa d’una adreça. Una sol·licitud des d’una altra adreça retorna 403 api_keys.ip_not_allowed. Cap valor vol dir sense restricció.

  items ≤ 50

S’usa a

• POST/v1/api-keysCrear una clau d’API