Uma chave da API Fleet permite que você se comunique diretamente com sua instância Fleet. Use uma para executar scripts, obter dados de dispositivos ou conectar o Fleet a outras ferramentas.

Funcionalidade

Visão Geral

As chaves da API Fleet (FleetDM) autenticam solicitações enviadas diretamente para sua instância Fleet. Você pode criá-las de três maneiras:

• Do Factorial IT, como uma chave somente leitura.
• Do painel do Fleet, como um token vinculado à sua conta de usuário do Fleet.
• Da linha de comando, com o Fleet CLI ou a API Fleet.

Os tokens da API Fleet nunca expiram por conta própria.

Como usar: criar uma chave do Factorial IT

1. Vá para Configurações > Desenvolvedores e role para baixo até a seção Chave da API FleetDM.
2. Digite um Nome da chave, por exemplo, a ferramenta que usará a chave.
3. Clique em Gerar chave.
4. Copie o token mostrado na janela Chave da API FleetDM criada. Ele permanece disponível depois na tabela de chaves.

As chaves criadas do Factorial IT são somente leitura. Elas podem ver todos os dispositivos e seus dados, mas não podem alterar configurações ou executar ações em dispositivos. Elas são adequadas para integrações externas que só precisam ler sua instância Fleet.

Para revogar uma, abra o menu ⋯ na sua linha na tabela Chave da API FleetDM e clique em Revogar. Qualquer integração que a utilize para de funcionar imediatamente.

Mantenha o token em segredo. Quem o possui pode ler seu inventário de dispositivos.

Criar uma chave do painel do Fleet

1. Abra seu painel do Fleet a partir do console via Configurações > MDM > Abrir Fleet.
2. Clique no seu avatar no canto superior direito e selecione Minha conta.
3. Role para baixo até Token da API.
4. Clique em Obter token da API.
5. Copie o token. Ele pertence à sua conta de usuário do Fleet.

Este token possui as mesmas permissões que sua conta de usuário do Fleet. Mantenha-o em segredo.

Criar uma chave da linha de comando

Com o Fleet CLI:

fleetctl login --email seu-email@exemplo.com --url https://<sua-instância-fleet>
fleetctl get api-token

Ou diretamente pela API Fleet:

curl -X POST https://<sua-instância-fleet>/api/v1/fleet/users/<user-id>/api_token \
  -H "Authorization: Bearer SEU_TOKEN_EXISTENTE" \
  -H "Content-Type: application/json"

Usar a chave

Envie o token no cabeçalho Authorization:

curl https://<sua-instância-fleet>/api/v1/fleet/hosts \
  -H "Authorization: Bearer SEU_TOKEN_API_FLEET"

Regenerar ou revogar um token

• Chave criada do Factorial IT: vá para Configurações > Desenvolvedores > Chave da API FleetDM, abra o menu ⋯ na sua linha e clique em Revogar.
• Token vinculado à sua conta de usuário do Fleet: no Fleet, vá para Minha conta e clique em Regenerar token da API. O token antigo para de funcionar imediatamente.

Solução de Problemas e FAQ

Solução de Problemas

• Uma integração parou de funcionar. Sua chave pode ter sido revogada, ou o token do usuário regenerado. Crie uma nova chave e atualize a integração.
• Uma solicitação para alterar configurações ou executar uma ação falha. Chaves criadas do Factorial IT são somente leitura. Use um token vinculado a uma conta de usuário do Fleet com as permissões corretas.
• Você perdeu o token. Para uma chave criada do Factorial IT, encontre-a novamente na tabela de chaves. Para um token de usuário, regenere-o em Minha conta no Fleet.

FAQ

1. Os tokens da API Fleet expiram?
   Não. Eles permanecem válidos até que você os revogue ou regenere.
    
2. O que uma chave criada do Factorial IT pode fazer?
   Ler todos os dispositivos e seus dados. Não pode alterar configurações ou executar ações em dispositivos.
    
3. Quais permissões um token do painel do Fleet possui?
   As mesmas da sua conta de usuário do Fleet.
    
4. O que acontece quando eu revogo uma chave?
   Toda integração que a utiliza para de funcionar imediatamente.