Esadax REST API erbjuder en omfattande uppsättning slutpunkter för hantering av olika resurser som hemligheter, brandväggar, team, användare och webhooks. Nedan följer en organiserad sammanfattning av hur du använder dessa slutpunkter effektivt:

Autentisering

• Metod: Se till att du har den nödvändiga autentiseringsmetoden på plats, vilket kan vara tokens eller API-nycklar. Kontrollera Esadax dokumentation för specifika detaljer.

Hantering av resurser

Hemligheter

• Hämta hemligheter: Använd GET /v2/secrets med paginering om det behövs.
• Uppdatera hemligt namn: Använd PATCH /v2/secrets/{name} för att ändra namnet och se till att det är unikt för varje användare eller team.

Konfiguration av brandvägg

• Hämta aktuell konfiguration: Använd GET /v1/firewalls/{configVersion}.
• Uppdateringskonfiguration: Använd PUT /v1/firewalls med nya regler.

Attack utmaning läge

• Aktivera/inaktivera: Använd POST /v1/attack-challenge-mode för att växla inställningen.

Lag

• Skapa Team: Skicka en POST-förfrågan till /v1/teams med slug och valfritt namn.
• Ta bort Team: Använd DELETE på /v1/teams/{teamId} med valfria skäl.
• Ta bort inbjudningskod: Använd DELETE på /v1/teams/{teamId}/invites/{inviteCode}.
• Få Team Info: Använd GET på /v2/teams/{teamId}.
• Lista medlemmar: Använd GET på /v2/teams/{teamId}/members, paginering efter behov.
• Bjud in användare: POST till /v1/teams/{teamId}/members med e-post eller ID (ID har företräde).
• Gå med i laget: POST till /v1/teams/join med inbjudningskod eller lag-ID.
• Uppdatera Team Info: PATCH på /v2/teams/{teamId} med nya detaljer.
• Ta bort medlem: DELETE på /v1/teams/{teamId}/members/{uid}.
• Begär åtkomst: POST till /v1/teams/{teamId}/request.
• Bekräfta begäran: PATCH på /v1/teams/{teamId}/members/{uid} om det bekräftas.

Användare

• Hämta användarinformation: Använd GET på /v2/user.
• Lista händelser: Använd GET på /v3/events.

Webbhook

• Skapa Webhook: POST till /v1/webhooks.
• Ta bort Webhook: DELETE på /v1/webhooks/{webhookId}.
• Hämta Webhook-information: GET på /v1/webhooks/{webhookId}.
• Lista Webhooks: Använd GET på /v1/webhooks.

De bästa metoderna

• Behörigheter: Se till att du har nödvändiga behörigheter, till exempel administratörsrättigheter eller ägarskap för teamhantering.
• Felhantering: Implementera felhantering för att hantera olika HTTP-statuskoder och fel på lämpligt sätt.

Exempel på arbetsflöde

1. Skapa ett lag:
   • Skicka POST till /v1/teams med {"slug": "example-team", "name": "Example Team"}.
2. Bjud in användare:
   • Använd POST på /v1/teams/{teamId}/members med användaruppgifter eller inbjudningskoder.
3. Gå med i teamet:
   • Skicka POST till /v1/teams/join med lag-ID eller inbjudningskod.
4. Uppdatera brandväggsregler:
   • PUT till /v1/firewalls med ny konfiguration.