Hygiëne van API-sleutels
Volledige of aangepaste toegang, een sleutel intrekken en vervangen, en een sleutel herkennen die niemand gebruikt.
Een API-sleutel handelt namens jou in je account, zonder dat je erbij bent: overal vandaan, tot hij wordt ingetrokken. Authenticatie legt uit hoe je een sleutel aanmaakt en meestuurt met een aanroep. Deze pagina gaat over het eerlijk houden van de sleutels die je al hebt.
Geef een sleutel alleen wat hij nodig heeft
Elke sleutel heeft Volledige toegang of Aangepaste toegang. Je kiest dit bij het aanmaken en kunt het later in hetzelfde formulier aanpassen.
- Volledige toegang bereikt elke methode die je account kan aanroepen, ook methoden die na het aanmaken van de sleutel zijn toegevoegd. Niets wat als privé is gemarkeerd wordt ooit meegenomen, welke toegangsmodus een sleutel ook heeft.
- Aangepaste toegang bereikt alleen de methoden die je expliciet hebt aangevinkt, gegroepeerd per microservice, met de eigen parameters van elke methode ernaast. Een methode die later wordt toegevoegd valt er niet onder totdat je terugkomt en die aanvinkt.
Een sleutel in een script, een CI-job of een server heeft alleen de handvol methoden nodig die die job echt aanroept. Met aangepaste toegang kan een gelekte sleutel niet meer doen dan het werk waarvoor hij is gemaakt.
Aanmaken, tonen en kopiëren
Om een sleutel aan te maken moet je account op niveau 2 geverifieerd zijn, zie Verificatie. De knop Key aanmaken legt dit uit en verwijst je direct naar de volgende onvoltooide stap als je er nog niet bent. De waarde van een nieuw aangemaakte sleutel zie je één keer in het paneel Snel kopiëren bovenaan de lijst. Daarna blijft hij in elke rij verborgen, en met de toonknop van een rij zie je hem opnieuw voor 20 seconden, waarna hij zichzelf weer verbergt.
De waarde wordt nooit naar een log, een toast of de adresbalk geschreven, alleen naar je klembord. Behandel hem precies als een wachtwoord. Iedereen die hem heeft, kan optreden als jouw account.
Vervangen, intrekken en een ongebruikte sleutel herkennen
Er is geen aparte actie om te roteren, omdat de waarde van een sleutel zijn eigen identificatie is. Vervangen maakt een nieuwe sleutel met dezelfde naam en toegang, trekt de oude in en toont de nieuwe waarde één keer, zodat je hem kunt kopiëren voordat je het dialoogvenster sluit. Intrekken verwijdert een sleutel definitief en vraagt je dit eerst op naam te bevestigen, omdat het niet ongedaan kan worden gemaakt.
In de rij van elke sleutel staat wanneer hij voor het laatst is gebruikt, op basis van de activiteit van de afgelopen 7 dagen. Een sleutel zonder regel eronder heeft in die periode geen enkele aanroep gedaan. Die rij verdient een tweede blik.
Vervang een sleutel die mogelijk is gelekt
Open de sleutel, druk op Vervangen en kopieer de nieuwe waarde zodra die verschijnt. De oude waarde werkt niet meer zodra het vervangen klaar is.
Trek een sleutel in die je niet meer nodig hebt
Druk in de rij op Intrekken en bevestig het op naam. Een ingetrokken sleutel verdwijnt uit de lijst met actieve sleutels en is niet terug te halen.
Zoek een sleutel die niemand gebruikt
Loop de lijst langs op een rij zonder regel "Laatst gebruikt", vooral bij sleutels met volledige toegang, en trek hem in als je niet kunt verklaren waarvoor hij dient.