Authenticatie
De axe MCP Server ondersteunt twee authenticatiemethoden. Beiden zijn beschikbaar voor alle gebruikers — kies degene die het beste bij uw workflow past:
- API-sleutel — een langlevende sleutel die gegenereerd is in het axe Account Portal. Het eenvoudigst om op te zetten.
- OAuth 2.0 — browser-gebaseerde login via de
@deque/axe-authCLI, met tokens die zijn opgeslagen in de sleutelhanger van je besturingssysteem en automatisch worden vernieuwd.
Je configureert de gekozen referentie in je client setup-gids. Elke setuppagina toont zowel de API-sleutel- als de OAuth-configuraties naast elkaar.
Stel ofwel AXE_API_KEY of AXE_ACCESS_TOKEN in — niet beide. De server zal bij het opstarten falen als beide variabelen zijn ingesteld.
API-sleutel
- Log in op de axe Accountportaal
- Navigeer naar de API-sleutels pagina
- Klik op NIEUWE API-SLEUTEL TOEVOEGEN
- Selecteer axe MCP Server als het product
- Voer een beschrijvende naam voor uw API-sleutel in
- Klik op Opslaan
- Kopieer de gegenereerde API-sleutel — je geeft deze door aan de server als de
AXE_API_KEY-omgevingsvariabele
OAuth 2.0
OAuth 2.0 maakt gebruik van de Autorisatiecode Flow met PKCE en slaat tokens veilig op in uw OS-sleutelhanger, zodat u één keer authenticeert en de CLI de tokenvernieuwing automatisch uitvoert.
Authenticatie wordt beheerd door @deque/axe-auth, een zelfstandige CLI die je apart op je hostmachine installeert.
Vereisten
- Een actieve Node.js LTS-versie
- Jouw gekozen axe MCP Server-distributie geïnstalleerd — zie Een Distributie Kiezen
Stap 1: Authenticeren
Voer het login-commando uit:
npx @deque/axe-auth loginDe CLI zal:
- Uw standaardbrowser openen naar de loginpagina
- U vragen zich aan te melden met uw axe Account-inloggegevens
- De resulterende tokens veilig opslaan in uw systeemsleutelhanger
Uw besturingssysteem kan u vragen toegang tot de sleutelhanger te verlenen de eerste keer dat tokens worden opgeslagen.
Wanneer voltooid, bevestigt de terminal:
✓ Authenticated.Je hoeft login slechts één keer per machine uit te voeren. Bij volgende oproepen vernieuwt npx @deque/axe-auth token je toegangstoken stilzwijgend met behulp van het opgeslagen vernieuwings-token.
Private cloud, niet-VS regio's, of lokale installaties
Als je organisatie een privécloud of een lokale axe-instantie gebruikt, geef dan de URL van je instantie door met --server (of stel de AXE_SERVER_URL-omgevingsvariabele in):
npx @deque/axe-auth login --server https://your-axe-instance.example.comStap 2: Uw cliënt configureren
Gebruik @deque/axe-auth token in je MCP-clientconfiguratie om een geldig toegangstoken in te voeren telkens wanneer de server start. Kies je client voor specifieke installatie-instructies:
Elke installatiepagina bevat een OAuth-configuratiesectie naast de API-sleutelinstructies.
Sessies beheren
Token levensduur
OAuth-toegangstokens hebben een korte levensduur. Als een sessie langer duurt dan de levensduur van het token, geeft de server authenticatiefouten.
Workaround: Herstart de MCP-serververbinding in je client. De configuratie voert @deque/axe-auth token opnieuw uit bij elke serverstart, wat automatisch een nieuwe token ophaalt.
Uitloggen
Om uw tokens aan de serverkant in te trekken en ze uit de systeemsleutelhanger te verwijderen:
npx @deque/axe-auth logoutAls intrekking aan de serverzijde mislukt (bijvoorbeeld door een netwerkfout), worden lokale tokens nog steeds gewist en wordt een waarschuwing afgedrukt.
Opnieuw authenticeren
Als je vernieuwings-token is verlopen of is ingetrokken, beëindigt @deque/axe-auth token met code 1 en stuurt het je aan om opnieuw in te loggen. Voer npx @deque/axe-auth login opnieuw uit. Geef --force door om de bevestigingsprompt voor herauthenticatie over te slaan:
npx @deque/axe-auth login --forceOpdrachtreferentie
login
Opent een browser, voltooit de OAuth 2.0 Authorization Code + PKCE-procedure en slaat tokens op in de OS-sleutelhanger.
npx @deque/axe-auth login [options]| Vlag | Beschrijving |
|---|---|
--server <url> |
Basis-URL van je axe-instantie. Standaard ingesteld op https://axe.deque.com. Alleen vereist voor privéclouds, niet-VS-regio's, of lokale installaties. |
--force |
Sla herauthenticatiebevestiging over wanneer al ingelogd. |
--allow-insecure-issuer |
Sta niet-loopback http-URL's toe (standaard is alleen https toegestaan; loopback http is altijd toegestaan). Geldt alleen voor login; token en logout gebruiken het beleid dat bij login is vastgelegd. |
--no-allow-insecure-issuer |
Forceer allowInsecureIssuer=false voor de nieuwe login (en de vermelding die het vasthoudt). Wederzijds exclusief met --allow-insecure-issuer. token en logout negeren deze vlag. |
token
Drukt een momenteel geldig toegangstoken af naar stdout. Vernieuwt stilzwijgend als het opgeslagen token is verlopen. Beëindigt met code 1 als niet geauthenticeerd.
npx @deque/axe-auth tokenlogout
Trekt het opgeslagen vernieuwingtokens aan de serverzijde in en wist het lokale sleutelhangeritem.
npx @deque/axe-auth logout--help
Toont hulpinformatie voor @deque/axe-auth en zijn commando's.
npx @deque/axe-auth --help
npx @deque/axe-auth <command> --helpPlatformondersteuning
| Platform | Tokenopslag |
|---|---|
| macOS | macOS-sleutelhanger |
| Windows | Windows Credential Manager |
| Linux | D-Bus Secret Service (GNOME Keyring, KWallet, enz.) |
Linux: @deque/axe-auth vereist een werkende D-Bus Secret Service. Omgevingen zonder GUI of minimale desktopomgevingen hebben er mogelijk geen beschikbaar. Als je een foutmelding ziet zoals:
System keychain load failed: <details>. On Linux this usually means no D-Bus Secret Service is running (e.g. GNOME Keyring or KWallet).vraag dan uw systeembeheerder om GNOME Keyring of een compatibele Secret Service-provider te configureren.
Probleemoplossing met OAuth
Browser opent niet automatisch
Als login geen browser kan openen, drukt het de autorisatie-URL af naar de terminal. Kopieer de URL en open deze handmatig om de authenticatie te voltooien.
Token verloopt tijdens lange sessies
Zie Token levensduur hierboven. Herstart de MCP-serververbinding in je client om een nieuw token te verkrijgen.
„Niet geauthenticeerd“ fout van token
Je sessie is verlopen of tokens zijn gewist. Voer npx @deque/axe-auth login opnieuw uit om opnieuw te authenticeren.
Fouten bij MCP-serverauthenticatie
- Bevestig dat alleen
AXE_ACCESS_TOKENis ingesteld (nietAXE_API_KEY) - Bevestig dat
AXE_SERVER_URLovereenkomt met je axe-instantie-URL — dit moet dezelfde URL zijn die bij--servertijdens het inloggen is gebruikt (ofhttps://axe.deque.comals je de standaard gebruikte) - Voer
npx @deque/axe-auth tokendirect uit in je terminal om te bevestigen dat je een geldig token hebt - Als het beëindigt met code
1, herauthenticeer metnpx @deque/axe-auth login
Linux-sleutelhanger niet beschikbaar
Zie de Platformondersteuning roeptekst hierboven.
