Portées des clés d’API
Chaque clé d’API détient des portées, et chaque opération qu’elle peut atteindre exige l’une d’elles. Une clé à laquelle manque la portée qu’exige une opération est refusée avec INSUFFICIENT_SCOPE, qui nomme la portée manquante. Une portée qui se termine par :write accorde aussi la portée :read correspondante.
org:read
Section intitulée « org:read »Lire les unités organisationnelles de l’organisation via l’API publique.
Type :read
org:write
Section intitulée « org:write »Créer, modifier et supprimer des unités organisationnelles via l’API publique.
Type : write · Accorde aussi : org:read
POST /api/public/v1/org-unitsDELETE /api/public/v1/org-units/{unit_id}PATCH /api/public/v1/org-units/{unit_id}
zones:read
Section intitulée « zones:read »Lire les Autonomy Zones, leur comportement Ask, leur dictionnaire et l’affectation des agents aux zones via l’API publique.
Type :read
GET /api/public/v1/agents/{agent_id}/zoneGET /api/public/v1/org-units/{unit_id}/zone/previewGET /api/public/v1/zonesGET /api/public/v1/zones/{zone_id}GET /api/public/v1/zones/{zone_id}/agentsGET /api/public/v1/zones/{zone_id}/ask-settingsGET /api/public/v1/zones/{zone_id}/dictionary
zones:write
Section intitulée « zones:write »Créer et modifier des Autonomy Zones, leur comportement Ask et leur dictionnaire, et affecter des agents aux zones via l’API publique.
Type : write · Accorde aussi : zones:read
DELETE /api/public/v1/agents/{agent_id}/zonePUT /api/public/v1/agents/{agent_id}/zonePOST /api/public/v1/org-units/{unit_id}/zoneDELETE /api/public/v1/zones/{zone_id}PATCH /api/public/v1/zones/{zone_id}/ask-settingsDELETE /api/public/v1/zones/{zone_id}/defaultPUT /api/public/v1/zones/{zone_id}/defaultPOST /api/public/v1/zones/{zone_id}/dictionary/tablesDELETE /api/public/v1/zones/{zone_id}/dictionary/tables/{name}DELETE /api/public/v1/zones/{zone_id}/dictionary/tables/{name}/valuesPOST /api/public/v1/zones/{zone_id}/dictionary/tables/{name}/values
policies:read
Section intitulée « policies:read »Lire les politiques d’intention et la politique déclarée via l’API publique.
Type :read
policies:write
Section intitulée « policies:write »Modifier les politiques d’intention et la politique déclarée via l’API publique.
Type : write · Accorde aussi : policies:read
POST /api/public/v1/policies/statedDELETE /api/public/v1/policies/{public_id}PATCH /api/public/v1/policies/{public_id}PATCH /api/public/v1/policies/{public_id}/ask-settingsPOST /api/public/v1/policies/{public_id}/copyPOST /api/public/v1/policies/{public_id}/editDELETE /api/public/v1/policies/{public_id}/intent-policies/{intent_policy_id}/cases/{case_id}DELETE /api/public/v1/policies/{public_id}/intent-policies/{intent_policy_id}/decisivePOST /api/public/v1/policies/{public_id}/promotePATCH /api/public/v1/policies/{public_id}/titlePOST /api/public/v1/policies/{public_id}/versions/{version}/applyPOST /api/public/v1/zones/{zone_id}/policy-attachmentsDELETE /api/public/v1/zones/{zone_id}/policy-attachments/{public_id}
proposals:read
Section intitulée « proposals:read »Lire les propositions d’apprentissage via l’API publique.
Type :read
proposals:write
Section intitulée « proposals:write »Accepter et écarter des propositions d’apprentissage via l’API publique.
Type : write · Accorde aussi : proposals:read
POST /api/public/v1/learning-proposals/{public_id}/acceptPOST /api/public/v1/learning-proposals/{public_id}/dismiss
presets:read
Section intitulée « presets:read »Lire les préréglages de politiques de l’organisation et leurs règles via l’API publique.
Type :read
presets:write
Section intitulée « presets:write »Modifier les préréglages de politiques de l’organisation et leurs règles via l’API publique.
Type : write · Accorde aussi : presets:read
POST /api/public/v1/policy-presetsDELETE /api/public/v1/policy-presets/{key}PATCH /api/public/v1/policy-presets/{key}POST /api/public/v1/policy-presets/{key}/rulesDELETE /api/public/v1/policy-presets/{key}/rules/{rule_id}
aip:read
Section intitulée « aip:read »Lire la rédaction des Agent Intent Policies via l’API publique (bêta).
Type :read
GET /api/public/v1/aip/authoring-metadataGET /api/public/v1/aip/drafts/{public_id}GET /api/public/v1/aip/jobs/{job_id}
aip:write
Section intitulée « aip:write »Rédiger des Agent Intent Policies via l’API publique (bêta).
Type : write · Accorde aussi : aip:read
POST /api/public/v1/aip/draftsDELETE /api/public/v1/aip/drafts/{public_id}PATCH /api/public/v1/aip/drafts/{public_id}DELETE /api/public/v1/aip/drafts/{public_id}/intent-policies/{intent_policy_id}PATCH /api/public/v1/aip/drafts/{public_id}/intent-policies/{intent_policy_id}POST /api/public/v1/aip/drafts/{public_id}/intent-policies/{intent_policy_id}/answersPATCH /api/public/v1/aip/drafts/{public_id}/intent-policies/{intent_policy_id}/cases/{index}POST /api/public/v1/aip/drafts/{public_id}/intent-policies/{intent_policy_id}/fixPOST /api/public/v1/aip/drafts/{public_id}/intent-policies/{intent_policy_id}/fix/applyPOST /api/public/v1/aip/drafts/{public_id}/preparePOST /api/public/v1/aip/drafts/{public_id}/ratifyPOST /api/public/v1/aip/drafts/{public_id}/replayPOST /api/public/v1/aip/sources
triage:read
Section intitulée « triage:read »Lire les anomalies, les motifs des Ask et les mises en attente via l’API publique.
Type :read
GET /api/public/v1/anomaliesGET /api/public/v1/anomalies/{public_id}GET /api/public/v1/asksGET /api/public/v1/holds
triage:write
Section intitulée « triage:write »Répondre aux anomalies, aux motifs des Ask et aux mises en attente via l’API publique.
Type : write · Accorde aussi : triage:read
PATCH /api/public/v1/anomalies/{public_id}POST /api/public/v1/asks/{ground_id}/answerPOST /api/public/v1/asks/{ground_id}/snoozePOST /api/public/v1/holds/{native_tool_use_id}/answer
alerts:read
Section intitulée « alerts:read »Lire les alertes de sécurité via l’API publique.
Type :read
alerts:write
Section intitulée « alerts:write »Modifier les alertes de sécurité via l’API publique.
Type : write · Accorde aussi : alerts:read
DELETE /api/public/v1/alerts/{alert_id}PATCH /api/public/v1/alerts/{alert_id}/dismissPATCH /api/public/v1/alerts/{alert_id}/readPATCH /api/public/v1/alerts/{alert_id}/restorePATCH /api/public/v1/alerts/{alert_id}/unread
agents:read
Section intitulée « agents:read »Lire les agents, leur propriété, leurs sessions, leur graphe d’exécution et les sessions d’inventaire via l’API publique.
Type :read
GET /api/public/v1/agentsGET /api/public/v1/agents/{agent_id}GET /api/public/v1/agents/{agent_id}/execution-graphGET /api/public/v1/agents/{agent_id}/execution-graph/node-eventsGET /api/public/v1/agents/{agent_id}/ownershipGET /api/public/v1/agents/{agent_id}/ownership/privilegesGET /api/public/v1/agents/{agent_id}/sessionsGET /api/public/v1/agents/{agent_id}/sessions/summaryGET /api/public/v1/inventory/sessions
agents:write
Section intitulée « agents:write »Modifier les agents, leur propriété et leurs sessions via l’API publique.
Type : write · Accorde aussi : agents:read
DELETE /api/public/v1/agents/{agent_id}PATCH /api/public/v1/agents/{agent_id}PATCH /api/public/v1/agents/{agent_id}/ownershipPOST /api/public/v1/agents/{agent_id}/ownership/recheckDELETE /api/public/v1/agents/{agent_id}/sessionsDELETE /api/public/v1/sessions/{session_id}PATCH /api/public/v1/sessions/{session_id}
host:run
Section intitulée « host:run »Exécuter le client OpenLatch sur un hôte : envoyer des événements, récupérer le bundle de politiques, mettre des actions en attente de revue, interroger les alertes et lire l’état de la licence.
Type :action
-
POST /api/v1/alerts/ack-all -
GET /api/v1/alerts/pending -
POST /api/v1/alerts/{alert_id}/ack -
POST /api/v1/events/ingest -
POST /api/v1/holds -
GET /api/v1/holds/{native_tool_use_id} -
POST /api/v1/hosts/identity -
GET /api/v1/hosts/self -
DELETE /api/v1/hosts/self/credential -
GET /api/v1/license/state -
GET /api/v1/policy/bundle
host:enroll
Section intitulée « host:enroll »Enroll a host and receive its host credential.
Type :action
-
POST /api/v1/hosts/enroll
Lire l’utilisateur et l’organisation de la clé elle-même, et révoquer la clé. Chaque clé la détient.
Type : implicit · Vous ne pouvez pas l’accorder à la création d’une clé.
GET /api/public/v1/users/me/context-
DELETE /api/v1/api-keys/self -
GET /api/v1/users/me -
DELETE /api/v1/users/me/api-keys/self
Full access (legacy) : chaque opération que la clé atteignait avant les portées. Détenue seulement par les clés créées avant les portées, jamais combinée à une autre portée.
Type : marker · Vous ne pouvez pas l’accorder à la création d’une clé.
Une opération qui ne figure sous aucune portée n’est pas accessible aux clés à portées : seule une clé « Full access (legacy) » l’atteint.