OAuth 2.0-authenticatie
Overzicht
OAuth 2.0 is een alternatief voor API-sleutelauthenticatie dat beschikbaar is voor alle gebruikers van de axe MCP Server. Het maakt gebruik van de Authorization Code Flow met PKCE en slaat tokens veilig op in de sleutelhanger van je besturingssysteem, zodat je slechts één keer hoeft te authenticeren en de CLI automatisch de tokenvernieuwing afhandelt.
Authenticatie wordt beheerd door @deque/axe-auth, een zelfstandige CLI die je afzonderlijk op je hostmachine installeert.
Vereisten
- Node.js 22 LTS of later
- Docker geïnstalleerd en actief
Stap 1: Authenticeer
Voer het login-commando uit:
npx @deque/axe-auth loginDe CLI zal:
- Je standaardbrowser openen naar de inlogpagina
- Je vragen om in te loggen met je axe-accountgegevens
- De resulterende tokens veilig opslaan in je systeem-sleutelhanger
Je besturingssysteem kan je vragen om toegang tot de sleutelhanger te verlenen de eerste keer dat tokens worden opgeslagen.
Wanneer dit klaar is, bevestigt de terminal:
✓ Authenticated.Je hoeft alleen login één keer per machine uit te voeren. Bij volgende oproepen ververst npx @deque/axe-auth token je toegangstoken stilletjes met de opgeslagen vernieuwings-token.
Privé cloud, niet-VS regio's, of on-premise installaties
Als je organisatie een privé cloud of on-premise axe-instantie gebruikt, geef je instanties-URL door met --server (of stel AXE_SERVER_URL omgevingsvariabele in):
npx @deque/axe-auth login --server https://your-axe-instance.example.comStap 2: Configureer je IDE
Gebruik @deque/axe-auth token in je MCP-clientconfiguratie om een geldig toegangstoken in de Docker-container te injecteren telkens als de server start. Omhul het Docker-commando met sh -c zodat de shell het token kan vervangen — MCP-configuratiebestanden zijn JSON en breiden $(...) niet direct uit:
Stel ofwel AXE_API_KEY in of AXE_ACCESS_TOKEN — niet beide. De server zal bij opstarten falen als beide variabelen zijn ingesteld.
Kies je IDE voor specifieke installatie-instructies:
Elke installatiepagina bevat een OAuth-configuratiesectie naast de API-sleutelinstructies.
Sessies beheren
Token levensduur
OAuth-toegangstokens zijn van korte duur. Als een sessie langer duurt dan de levensduur van het token, zal de server authenticatiefouten retourneren.
Oplossing: Herstart de MCP-serververbinding in je IDE. De configuratie wordt opnieuw uitgevoerd @deque/axe-auth token bij elke serverstart, waardoor automatisch een nieuw token wordt opgehaald.
Uitloggen
Om je tokens server-side te herroepen en ze uit de systeem-sleutelhanger te verwijderen:
npx @deque/axe-auth logoutAls server-side herroeping mislukt (bijvoorbeeld door een netwerkfout), worden lokale tokens nog steeds verwijderd en wordt er een waarschuwing weergegeven.
Opnieuw authenticeren
Als je vernieuwings-token is verlopen of herroepen, @deque/axe-auth token stopt met code 1 en vraagt je om opnieuw in te loggen. Voer npx @deque/axe-auth login opnieuw uit. Geef --force 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-stroom en slaat tokens op in de OS-sleutelhanger.
npx @deque/axe-auth login [options]| Vlag | Beschrijving |
|---|---|
--server <url> |
Basis-URL van uw axe-instantie. Standaard is https://axe.deque.com. Alleen vereist voor privécloud, niet-VS-regio's of on-premises installaties. |
--force |
Sla de bevestiging voor herauthenticatie over wanneer u al aangemeld bent. |
--allow-insecure-issuer |
Sta niet-loopback http-URL's toe (standaard is alleen https; loopback http is altijd toegestaan). Geldt voor login alleen; token en logout gebruiken het beleid dat is opgeslagen bij de aanmelding. |
--no-allow-insecure-issuer |
Forceer allowInsecureIssuer=false voor de nieuwe login (en de vastgelegde invoer). Uitsluitend aanwezig met --allow-insecure-issuer. token en logout negeren deze vlag. |
token
Print een momenteel geldig toegangstoken naar stdout. Vernieuwt stilletjes als het opgeslagen token verlopen is. Stopt met code 1 als niet geauthenticeerd.
npx @deque/axe-auth tokenlogout
Herroept het opgeslagen verversingstoken aan de serverzijde en wist de lokale sleutelhangerinvoer.
npx @deque/axe-auth logout--help
Geeft helpinformatie weer voor @deque/axe-auth en zijn opdrachten.
npx @deque/axe-auth --help
npx @deque/axe-auth <command> --helpOndersteuning van het platform
| Platform | Tokenopslag |
|---|---|
| macOS | macOS-sleutelhanger |
| Windows | Windows Credential Manager |
| Linux | D-Bus Secret Service (GNOME Keyring, KWallet, etc.) |
Linux: @deque/axe-auth vereist een werkende D-Bus Secret Service. Omgevingen zonder scherm of met minimaal bureaublad hebben mogelijk geen beschikbare service. Als u 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 uw systeembeheerder om GNOME Keyring of een compatibele Secret Service-provider te configureren.
Probleemoplossing
Browser opent niet automatisch
Als login geen browser kan openen, wordt de autorisatie-URL naar de terminal geschreven. Kopieer de URL en open deze handmatig om de authenticatie te voltooien.
Tokenverval tijdens lange sessies
Zie Tokenlevensduur hierboven. Herstart de MCP-serververbinding in uw IDE om een nieuw token te verkrijgen.
Foutmelding 'Niet geauthenticeerd' van token
Uw sessie is verlopen of tokens zijn gewist. Voer npx @deque/axe-auth login opnieuw uit om te herauthenticeren.
Authenticatiefouten van de MCP-server
- Bevestig alleen dat
AXE_ACCESS_TOKENis ingesteld (nietAXE_API_KEY) - Bevestig
AXE_SERVER_URLkomt overeen met je axe instance-URL — dit moet dezelfde URL zijn die je gebruikt hebt met--servertijdens het inloggen (ofhttps://axe.deque.comals je de standaard gebruikte) - Voer
npx @deque/axe-auth tokendirect in je terminal uit om te bevestigen dat je een geldige token hebt - Als het afsluit met code
1, her-authenticeer dan metnpx @deque/axe-auth login
Linux-sleutelhanger niet beschikbaar
Zie de Platformondersteuning aankondiging hierboven.
