Autenticação

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data

O servidor axe MCP suporta dois métodos de autenticação. Ambos estão disponíveis para todos os usuários — escolha o que melhor se adapta ao seu fluxo de trabalho:

  • Chave de API — uma chave de longa duração gerada no Portal de Contas do axe. O mais simples para configurar.
  • OAuth 2.0 — login baseado em navegador via o @deque/axe-auth CLI, com tokens armazenados no keychain do seu SO e atualizados automaticamente.

Você configura a credencial escolhida no seu guia de configuração do cliente. Cada página de configuração mostra as configurações de chave API e OAuth lado a lado.

note

Defina ou AXE_API_KEY ou AXE_ACCESS_TOKEN — não ambos. O servidor falhará ao iniciar se ambas as variáveis estiverem definidas.

Chave de API

  1. Faça login no Portal de Contas do axe
  2. Navegue até a página de Chaves de API
  3. Clique em ADICIONAR NOVA CHAVE DE API
  4. Selecione axe MCP Server como o produto
  5. Digite um nome descritivo para sua chave de API
  6. Clique em Salvar
  7. Copie a chave de API gerada — você a passará para o servidor como a AXE_API_KEY variável de ambiente

OAuth 2.0

OAuth 2.0 usa o Authorization Code Flow com PKCE e armazena tokens de forma segura no keychain do seu SO, para que você autentique uma vez e o CLI gerencie a atualização de tokens automaticamente.

A autenticação é gerida pelo @deque/axe-auth, um CLI independente que você instala separadamente na sua máquina host.

Pré-requisitos

Passo 1: Autenticar

Execute o comando de login:

npx @deque/axe-auth login

O CLI irá:

  1. Abrir seu navegador padrão na página de login
  2. Solicitar que você faça login com suas credenciais de Conta do axe
  3. Armazenar os tokens resultantes de forma segura no keychain do seu sistema
note

Seu sistema operacional pode solicitar que você conceda acesso ao keychain a primeira vez que os tokens forem armazenados.

Quando concluir, o terminal confirma:

✓ Authenticated.

Você só precisa executar login uma vez por máquina. Nas invocações subsequentes, npx @deque/axe-auth token atualiza seu token de acesso silenciosamente usando o token de atualização armazenado.

Nuvem privada, regiões fora dos EUA, ou instalações no local

Se sua organização usa uma nuvem privada ou uma instância axe local, passe a URL da sua instância com --server (ou defina AXE_SERVER_URL var de ambiente):

npx @deque/axe-auth login --server https://your-axe-instance.example.com

Passo 2: Configure seu cliente

Use @deque/axe-auth token na sua configuração de cliente MCP para injetar um token de acesso válido cada vez que o servidor iniciar. Escolha seu cliente para instruções de configuração específicas:

Cada página de configuração inclui uma seção de configuração OAuth juntamente com as instruções de chave API.

Gerenciando sessões

Duração do token

Os tokens de acesso OAuth são de curta duração. Se uma sessão durar mais do que o tempo de vida do token, o servidor retornará erros de autenticação.

Solução alternativa: Reinicie a conexão do servidor MCP no seu cliente. A configuração é reexecutada @deque/axe-auth token em cada inicialização do servidor, o que obtém automaticamente um token novo.

Desconectando

Para revogar seus tokens do lado do servidor e removê-los do chaveiro do sistema:

npx @deque/axe-auth logout

Se a revogação do lado do servidor falhar (por exemplo, devido a um erro de rede), os tokens locais ainda serão removidos e um aviso será impresso.

Reautenticando

Se seu token de atualização expirou ou foi revogado, @deque/axe-auth token sai com o código 1 e direciona você a fazer login novamente. Execute npx @deque/axe-auth login novamente. Passe --force para pular o prompt de confirmação de reautenticação:

npx @deque/axe-auth login --force

Referência de comando

login

Abre um navegador, completa o fluxo OAuth 2.0 de Código de Autorização + PKCE, e preserva tokens no chaveiro do sistema operacional.

npx @deque/axe-auth login [options]
Flag Descrição
--server <url> URL base da sua instância axe. O padrão é https://axe.deque.com. Necessário apenas para nuvem privada, regiões fora dos EUA ou instalações locais.
--force Pular confirmação de reautenticação quando já estiver logado.
--allow-insecure-issuer Permitir URLs http não-loopback (o padrão é apenas https; o http de loopback é sempre permitido). Aplica-se a login apenas; token e logout usam a política preservada no login.
--no-allow-insecure-issuer Forçar allowInsecureIssuer=false para o novo login (e a entrada que preserva). Mutuamente exclusivo com --allow-insecure-issuer. token e logout ignoram esta flag.

token

Imprime um token de acesso atualmente válido na saída padrão. Atualiza silenciosamente se o token armazenado estiver expirado. Sai com o código 1 se não autenticado.

npx @deque/axe-auth token

logout

Revoga o token de atualização armazenado no lado do servidor e limpa a entrada local do chaveiro.

npx @deque/axe-auth logout

--help

Exibe informações de ajuda para @deque/axe-auth e seus comandos.

npx @deque/axe-auth --help
npx @deque/axe-auth <command> --help

Suporte à plataforma

Plataforma Armazenamento de Token
macOS Chaveiro do macOS
Windows Gerenciador de Credenciais do Windows
Linux D-Bus Secret Service (GNOME Keyring, KWallet, etc.)
caution

Linux: @deque/axe-auth requer um D-Bus Secret Service funcional. Ambientes sem interface gráfica ou com desktops minimalistas podem não ter um disponível. Se você vir um erro como:

System keychain load failed: <details>. On Linux this usually means no D-Bus Secret Service is running (e.g. GNOME Keyring or KWallet).

peça ao administrador do sistema para configurar o GNOME Keyring ou um provedor de Secret Service compatível.

Resolução de problemas OAuth

O navegador não abre automaticamente

Se login não puder abrir um navegador, imprime o URL de autorização no terminal. Copie o URL e abra-o manualmente para completar a autenticação.

Expiração de token durante longas sessões

Veja Duração do token acima. Reinicie a conexão do servidor MCP no seu cliente para obter um novo token.

Erro "Não autenticado" de token

Sua sessão expirou ou os tokens foram limpos. Execute npx @deque/axe-auth login novamente para reautenticar.

Erros de autenticação do servidor MCP

  • Confirme que apenas AXE_ACCESS_TOKEN está definido (não AXE_API_KEY)
  • Confirme que AXE_SERVER_URL corresponde ao URL da instância do axe — este deve ser o mesmo URL usado com --server durante o login (ou https://axe.deque.com se você usou o padrão)
  • Execute npx @deque/axe-auth token diretamente no seu terminal para confirmar que você possui um token válido
  • Se ele sair com o código 1, reautentique com npx @deque/axe-auth login

Cadeia de chaves do Linux indisponível

Veja a Suporte da Plataforma destacado acima.

Is this page helpful?

Help us improve this page

Still need help?