Objets
ApiKeyScope
Portée d’une clé API. Chaque opération publique déclare sa portée fine resource:action dans l’extension x-scope : cards:read et cards:write couvrent les fiches, les collections et les dossiers ; search et ask couvrent la recherche et les questions ; import:write couvre les sources personnalisées ; webhooks:manage couvre les webhooks et le flux d’événements ; users:read et users:write couvrent les utilisateurs et les groupes ; analytics:read et audit:read couvrent les analyses et le journal d’audit ; finance:read et catalog:read couvrent les requêtes financières et le catalogue de services ; files:read et files:write couvrent les fichiers ; permissions:manage couvre les permissions sur les objets ; admin couvre toutes les portées, y compris les paramètres de l’organisation et les clés. Les anciennes portées read, write et admin continuent de fonctionner : read signifie cards:read, search, ask, users:read, analytics:read, finance:read, catalog:read, files:read ; write signifie l’ensemble read plus cards:write, files:write, users:write, permissions:manage ; admin signifie toutes les portées. system n’appartient qu’aux clés de l’organisation de service.
Champs
Valeurs autorisées: readwriteadminsystemcards:readcards:writesearchaskimport:writewebhooks:manageusers:readusers:writeanalytics:readaudit:readfinance:readcatalog:readfiles:readfiles:writepermissions:manage