Startpagina/Artikel
Esadax JournalPlatform

Esadax REST API Endpoints Overzicht

De Esadax REST API biedt een uitgebreide set eindpunten voor het beheren van verschillende bronnen zoals geheimen, firewalls, teams, gebruikers en webhooks. Hieronder volgt een georganiseerde samenvatting van hoe u deze eindpunten

De Esadax REST API biedt een uitgebreide set eindpunten voor het beheren van verschillende bronnen zoals geheimen, firewalls, teams, gebruikers en webhooks. Hieronder volgt een georganiseerde samenvatting van hoe u deze eindpunten effectief kunt gebruiken:

Verificatie

  • Methode: Zorg ervoor dat u over de benodigde verificatiemethode beschikt, zoals tokens of API-sleutels. Raadpleeg de documentatie van Esadax voor specifieke details.

Beheer van hulpbronnen

Geheimen.

  • Retrieve Secrets: Gebruik GET /v2/secrets met paginatie indien nodig.
  • Geheime naam bijwerken: Gebruik PATCH /v2/secrets/{name} om de naam te wijzigen, zodat deze uniek is per gebruiker of team.

Configuratie van firewall

  • Huidige configuratie ophalen: Gebruik GET /v1/firewalls/{configVersion}.
  • Update Configuratie: Gebruik PUT /v1/firewalls met nieuwe regels.

Aanval uitdaging modus

  • Inschakelen/Uitschakelen: Gebruik POST /v1/attack-challenge-mode om de instelling te schakelen.

Teams

  • Create Team: Stuur een POST verzoek naar /v1/teams met slug en optionele naam.
  • Team verwijderen: Gebruik DELETE op /v1/teams/{teamId} met optionele redenen.
  • Verwijder uitnodigingscode: Gebruik DELETE op /v1/teams/{teamId}/invites/{inviteCode}.
  • Krijg Team Info: Gebruik GET op /v2/teams/{teamId}.
  • Lijst leden: Gebruik GET op /v2/teams/{teamId}/members, paginatie als nodig.
  • Gebruikers uitnodigen: POST naar /v1/teams/{teamId}/members met e-mail of ID (ID heeft voorrang).
  • Word lid van het team: POST naar /v1/teams/join met uitnodigingscode of team-ID.
  • Update Team Info: PATCH op /v2/teams/{teamId} met nieuwe details.
  • Verwijder lid: DELETE op /v1/teams/{teamId}/members/{uid}.
  • Toegang aanvragen: POST naar /v1/teams/{teamId}/request.
  • Verzoek bevestigen: PATCH op /v1/teams/{teamId}/members/{uid} indien bevestigd.

Gebruikers

  • Get User Info: Gebruik GET op /v2/user.
  • Lijst gebeurtenissen: Gebruik GET op /v3/events.

Webhooks

  • Webhook aanmaken: POST naar /v1/webhooks.
  • Webhook verwijderen: DELETE op /v1/webhooks/{webhookId}.
  • Webhook-informatie ophalen: GET op /v1/webhooks/{webhookId}.
  • Webhooks weergeven: Gebruik GET op /v1/webhooks.

De beste praktijken

  • Machtigingen: Zorg ervoor dat je de benodigde machtigingen hebt, zoals beheerdersrechten of eigenaarschap voor teambeheer.
  • Foutafhandeling: Implementeer foutafhandeling om verschillende HTTP-statuscodes en fouten op de juiste manier te beheren.

Voorbeeld van Workflow

  1. Een team aanmaken:
    • Stuur POST naar /v1/teams met {"slug": "example-team", "name": "Example Team"}.
  2. Gebruikers uitnodigen:
    • Gebruik POST op /v1/teams/{teamId}/members met gebruikersgegevens of uitnodigingscodes.
  3. Word lid van het team:
    • Stuur POST naar /v1/teams/join met de team-ID of uitnodigingscode.
  4. Firewallregels bijwerken:
    • PUT naar /v1/firewalls met nieuwe configuratie.
Abonneren