Una clave de API de Fleet te permite comunicarte directamente con tu instancia de Fleet. Úsala para ejecutar scripts, obtener datos de dispositivos o conectar Fleet con otras herramientas.

Funcionalidad

Descripción general

Las claves de API de Fleet (FleetDM) autentican las solicitudes enviadas directamente a tu instancia de Fleet. Puedes crearlas de tres maneras:

• Desde Factorial IT, como una clave de solo lectura.
• Desde el panel de control de Fleet, como un token vinculado a tu cuenta de usuario de Fleet.
• Desde la línea de comandos, con el CLI de Fleet o la API de Fleet.

Los tokens de API de Fleet nunca expiran por sí solos.

Cómo usar: crear una clave desde Factorial IT

1. Ve a Configuración > Desarrolladores y desplázate hacia abajo hasta la sección de Clave de API de FleetDM.
2. Escribe un Nombre de clave, por ejemplo, la herramienta que usará la clave.
3. Haz clic en Generar clave.
4. Copia el token que se muestra en la ventana de Clave de API de FleetDM creada. Permanecerá disponible después en la tabla de claves.

Las claves creadas desde Factorial IT son de solo lectura. Pueden ver cada dispositivo y sus datos, pero no pueden cambiar configuraciones ni ejecutar acciones en dispositivos. Son adecuadas para integraciones externas que solo necesitan leer tu instancia de Fleet.

Para revocar una, abre el menú ⋯ en su fila en la tabla de Clave de API de FleetDM y haz clic en Revocar. Cualquier integración que la use dejará de funcionar de inmediato.

Mantén el token en secreto. Quien lo tenga puede leer tu inventario de dispositivos.

Crea una clave desde el panel de control de Fleet

1. Abre tu panel de control de Fleet desde la consola a través de Configuración > MDM > Abrir Fleet.
2. Haz clic en tu avatar en la esquina superior derecha y selecciona Mi cuenta.
3. Desplázate hacia abajo hasta Token de API.
4. Haz clic en Obtener token de API.
5. Copia el token. Pertenece a tu cuenta de usuario de Fleet.

Este token tiene los mismos permisos que tu cuenta de usuario de Fleet. Mantenlo en secreto.

Crea una clave desde la línea de comandos

Con el CLI de Fleet:

fleetctl login --email tu-email@ejemplo.com --url https://<tu-instancia-de-fleet>
fleetctl get api-token

O directamente a través de la API de Fleet:

curl -X POST https://<tu-instancia-de-fleet>/api/v1/fleet/users/<user-id>/api_token \
  -H "Authorization: Bearer TU_TOKEN_EXISTENTE" \
  -H "Content-Type: application/json"

Usa la clave

Envía el token en el encabezado Authorization:

curl https://<tu-instancia-de-fleet>/api/v1/fleet/hosts \
  -H "Authorization: Bearer TU_TOKEN_API_FLEET"

Regenerar o revocar un token

• Clave creada desde Factorial IT: ve a Configuración > Desarrolladores > Clave de API de FleetDM, abre el menú ⋯ en su fila y haz clic en Revocar.
• Token vinculado a tu cuenta de usuario de Fleet: en Fleet, ve a Mi cuenta y haz clic en Regenerar token de API. El token antiguo deja de funcionar de inmediato.

Solución de problemas y FAQ

Solución de problemas

• Una integración dejó de funcionar. Su clave puede haber sido revocada, o el token de usuario regenerado. Crea una nueva clave y actualiza la integración.
• Una solicitud para cambiar configuraciones o ejecutar una acción falla. Las claves creadas desde Factorial IT son de solo lectura. Usa un token vinculado a una cuenta de usuario de Fleet con los permisos adecuados.
• Perdiste el token. Para una clave creada desde Factorial IT, encuéntrala nuevamente en la tabla de claves. Para un token de usuario, regénéralo en Mi cuenta en Fleet.

FAQ

1. ¿Expiran los tokens de API de Fleet?
   No. Permanecen válidos hasta que los revocas o regeneras.
    
2. ¿Qué puede hacer una clave creada desde Factorial IT?
   Leer cada dispositivo y sus datos. No puede cambiar configuraciones ni ejecutar acciones en dispositivos.
    
3. ¿Qué permisos tiene un token del panel de control de Fleet?
   Los mismos que tu cuenta de usuario de Fleet.
    
4. ¿Qué sucede cuando revoco una clave?
   Cualquier integración que la use deja de funcionar de inmediato.