Ámbitos de las claves de API

Cada clave de API tiene ámbitos, y cada operación a la que puede llegar exige uno de ellos. Una clave a la que le falta el ámbito que exige una operación se rechaza con INSUFFICIENT_SCOPE, que nombra el ámbito que falta. Un ámbito que termina en :write también concede el ámbito :read correspondiente.

org:read

Leer las unidades organizativas de la organización mediante la API pública.

Tipo:read

• GET /api/public/v1/org-units

org:write

Crear, modificar y eliminar unidades organizativas mediante la API pública.

Tipo: write · También concede: org:read

• POST /api/public/v1/org-units
• DELETE /api/public/v1/org-units/{unit_id}
• PATCH /api/public/v1/org-units/{unit_id}

zones:read

Leer las Autonomy Zones, su comportamiento Ask, su diccionario y la asignación de los agentes a las zonas mediante la API pública.

Tipo:read

• GET /api/public/v1/agents/{agent_id}/zone
• GET /api/public/v1/org-units/{unit_id}/zone/preview
• GET /api/public/v1/zones
• GET /api/public/v1/zones/{zone_id}
• GET /api/public/v1/zones/{zone_id}/agents
• GET /api/public/v1/zones/{zone_id}/ask-settings
• GET /api/public/v1/zones/{zone_id}/dictionary

zones:write

Crear y modificar Autonomy Zones, su comportamiento Ask y su diccionario, y asignar agentes a las zonas mediante la API pública.

Tipo: write · También concede: zones:read

• DELETE /api/public/v1/agents/{agent_id}/zone
• PUT /api/public/v1/agents/{agent_id}/zone
• POST /api/public/v1/org-units/{unit_id}/zone
• DELETE /api/public/v1/zones/{zone_id}
• PATCH /api/public/v1/zones/{zone_id}/ask-settings
• DELETE /api/public/v1/zones/{zone_id}/default
• PUT /api/public/v1/zones/{zone_id}/default
• POST /api/public/v1/zones/{zone_id}/dictionary/tables
• DELETE /api/public/v1/zones/{zone_id}/dictionary/tables/{name}
• DELETE /api/public/v1/zones/{zone_id}/dictionary/tables/{name}/values
• POST /api/public/v1/zones/{zone_id}/dictionary/tables/{name}/values

policies:read

Leer las políticas de intención y la política declarada mediante la API pública.

Tipo:read

• GET /api/public/v1/policies/{public_id}
• GET /api/public/v1/zones/{zone_id}/policies

policies:write

Modificar las políticas de intención y la política declarada mediante la API pública.

Tipo: write · También concede: policies:read

• POST /api/public/v1/policies/stated
• DELETE /api/public/v1/policies/{public_id}
• PATCH /api/public/v1/policies/{public_id}
• PATCH /api/public/v1/policies/{public_id}/ask-settings
• POST /api/public/v1/policies/{public_id}/copy
• POST /api/public/v1/policies/{public_id}/edit
• DELETE /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}/decisive
• POST /api/public/v1/policies/{public_id}/promote
• PATCH /api/public/v1/policies/{public_id}/title
• POST /api/public/v1/policies/{public_id}/versions/{version}/apply
• POST /api/public/v1/zones/{zone_id}/policy-attachments
• DELETE /api/public/v1/zones/{zone_id}/policy-attachments/{public_id}

proposals:read

Leer las propuestas de aprendizaje mediante la API pública.

Tipo:read

• GET /api/public/v1/learning-proposals
• GET /api/public/v1/learning-proposals/{public_id}

proposals:write

Aceptar y descartar propuestas de aprendizaje mediante la API pública.

Tipo: write · También concede: proposals:read

• POST /api/public/v1/learning-proposals/{public_id}/accept
• POST /api/public/v1/learning-proposals/{public_id}/dismiss

presets:read

Leer los ajustes predefinidos de políticas de la organización y sus reglas mediante la API pública.

Tipo:read

• GET /api/public/v1/policy-presets

presets:write

Modificar los ajustes predefinidos de políticas de la organización y sus reglas mediante la API pública.

Tipo: write · También concede: presets:read

• POST /api/public/v1/policy-presets
• DELETE /api/public/v1/policy-presets/{key}
• PATCH /api/public/v1/policy-presets/{key}
• POST /api/public/v1/policy-presets/{key}/rules
• DELETE /api/public/v1/policy-presets/{key}/rules/{rule_id}

aip:read

Leer la redacción de las Agent Intent Policies mediante la API pública (beta).

Tipo:read

• GET /api/public/v1/aip/authoring-metadata
• GET /api/public/v1/aip/drafts/{public_id}
• GET /api/public/v1/aip/jobs/{job_id}

aip:write

Redactar Agent Intent Policies mediante la API pública (beta).

Tipo: write · También concede: aip:read

• POST /api/public/v1/aip/drafts
• DELETE /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}/answers
• PATCH /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}/fix
• POST /api/public/v1/aip/drafts/{public_id}/intent-policies/{intent_policy_id}/fix/apply
• POST /api/public/v1/aip/drafts/{public_id}/prepare
• POST /api/public/v1/aip/drafts/{public_id}/ratify
• POST /api/public/v1/aip/drafts/{public_id}/replay
• POST /api/public/v1/aip/sources

triage:read

Leer las anomalías, los motivos de los Ask y las retenciones mediante la API pública.

Tipo:read

• GET /api/public/v1/anomalies
• GET /api/public/v1/anomalies/{public_id}
• GET /api/public/v1/asks
• GET /api/public/v1/holds

triage:write

Responder a las anomalías, a los motivos de los Ask y a las retenciones mediante la API pública.

Tipo: write · También concede: triage:read

• PATCH /api/public/v1/anomalies/{public_id}
• POST /api/public/v1/asks/{ground_id}/answer
• POST /api/public/v1/asks/{ground_id}/snooze
• POST /api/public/v1/holds/{native_tool_use_id}/answer

alerts:read

Leer las alertas de seguridad mediante la API pública.

Tipo:read

• GET /api/public/v1/alerts

alerts:write

Modificar las alertas de seguridad mediante la API pública.

Tipo: write · También concede: alerts:read

• DELETE /api/public/v1/alerts/{alert_id}
• PATCH /api/public/v1/alerts/{alert_id}/dismiss
• PATCH /api/public/v1/alerts/{alert_id}/read
• PATCH /api/public/v1/alerts/{alert_id}/restore
• PATCH /api/public/v1/alerts/{alert_id}/unread

agents:read

Leer los agentes, su propiedad, sus sesiones, su grafo de ejecución y las sesiones de inventario mediante la API pública.

Tipo:read

• GET /api/public/v1/agents
• GET /api/public/v1/agents/{agent_id}
• GET /api/public/v1/agents/{agent_id}/execution-graph
• GET /api/public/v1/agents/{agent_id}/execution-graph/node-events
• GET /api/public/v1/agents/{agent_id}/ownership
• GET /api/public/v1/agents/{agent_id}/ownership/privileges
• GET /api/public/v1/agents/{agent_id}/sessions
• GET /api/public/v1/agents/{agent_id}/sessions/summary
• GET /api/public/v1/inventory/sessions

agents:write

Modificar los agentes, su propiedad y sus sesiones mediante la API pública.

Tipo: write · También concede: agents:read

• DELETE /api/public/v1/agents/{agent_id}
• PATCH /api/public/v1/agents/{agent_id}
• PATCH /api/public/v1/agents/{agent_id}/ownership
• POST /api/public/v1/agents/{agent_id}/ownership/recheck
• DELETE /api/public/v1/agents/{agent_id}/sessions
• DELETE /api/public/v1/sessions/{session_id}
• PATCH /api/public/v1/sessions/{session_id}

host:run

Ejecutar el cliente de OpenLatch en un host: enviar eventos, obtener el paquete de políticas, retener acciones para su revisión, consultar las alertas y leer el estado de la licencia.

Tipo: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

Enroll a host and receive its host credential.

Tipo:action

• POST /api/v1/hosts/enroll

self

Leer el usuario y la organización de la propia clave, y revocar la clave. Toda clave lo tiene.

Tipo: implicit · No puede concederlo al crear una clave.

• 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

legacy

Full access (legacy): cada operación a la que llegaba la clave antes de los ámbitos. Solo la tienen las claves creadas antes de los ámbitos, y nunca se combina con otro ámbito.

Tipo: marker · No puede concederlo al crear una clave.

Una operación que no figura bajo ningún ámbito no está disponible para las claves con ámbitos: solo una clave «Full access (legacy)» llega a ella.