Startseite/Artikel
Esadax JournalPlatform

Esadax REST API Endpunkte Übersicht

Die Esadax REST API bietet eine umfassende Reihe von Endpunkten für die Verwaltung verschiedener Ressourcen wie Secrets, Firewalls, Teams, Benutzer und Webhooks. Im Folgenden finden Sie eine organisierte Zusammenfassung, wie Sie diese

Die Esadax REST API bietet eine umfassende Reihe von Endpunkten für die Verwaltung verschiedener Ressourcen wie Secrets, Firewalls, Teams, Benutzer und Webhooks. Im Folgenden finden Sie eine organisierte Zusammenfassung, wie Sie diese Endpunkte effektiv nutzen können:

Authentifizierung

  • Methode: Stellen Sie sicher, dass Sie über die erforderliche Authentifizierungsmethode verfügen, z. B. Token oder API-Schlüssel. Spezifische Details finden Sie in der Dokumentation von Esadax.

Verwaltung von Ressourcen

Secrets

  • Retrieve Secrets: Verwenden Sie GET /v2/secrets mit Paginierung, wenn nötig.
  • Geheimnamen aktualisieren: Verwenden Sie PATCH /v2/secrets/{name}, um den Namen zu ändern und sicherzustellen, dass er für jeden Benutzer oder jedes Team eindeutig ist.

Konfiguration der Firewall

  • Aktuelle Konfiguration erhalten: Verwenden Sie GET /v1/firewalls/{configVersion}.
  • Konfiguration aktualisieren: Verwenden Sie PUT /v1/firewalls mit neuen Regeln.

Angriffs-Herausforderungsmodus

  • Aktivieren/Deaktivieren: Verwenden Sie POST /v1/attack-challenge-mode, um die Einstellung umzuschalten.

Teams

  • Team erstellen: Senden Sie eine POST-Anfrage an /v1/teams mit Slug und optionalem Namen.
  • Team löschen: Verwenden Sie DELETE auf /v1/teams/{teamId} mit optionalen Gründen.
  • Einladungscode löschen: Verwenden Sie DELETE auf /v1/teams/{teamId}/invites/{inviteCode}.
  • Get Team Info: Verwenden Sie GET auf /v2/teams/{teamId}.
  • Liste Mitglieder: Verwenden Sie GET auf /v2/teams/{teamId}/members, Paginierung nach Bedarf.
  • Benutzer einladen: POST an /v1/teams/{teamId}/members mit E-Mail oder ID (ID hat Vorrang).
  • Team beitreten: POST an /v1/teams/join mit Einladungscode oder Team-ID.
  • Update Team Info: Patch auf /v2/teams/{teamId} mit neuen Details.
  • Mitglied entfernen: DELETE auf /v1/teams/{teamId}/members/{uid}.
  • Zugriff anfordern: POST an /v1/teams/{teamId}/request.
  • Anfrage bestätigen: PATCH auf /v1/teams/{teamId}/members/{uid} bei Bestätigung.

Users

  • Benutzerinformationen abrufen: Verwenden Sie GET auf /v2/user.
  • Ereignisse auflisten: Verwenden Sie GET auf /v3/events.

Webhook

  • Webhook erstellen: POST an /v1/webhooks.
  • Webhook löschen: DELETE auf /v1/webhooks/{webhookId}.
  • Webhook-Informationen abrufen: GET auf /v1/webhooks/{webhookId}.
  • Webhooks auflisten: Verwenden Sie GET auf /v1/webhooks.

Best Practices für Unternehmen

  • Berechtigungen: Stellen Sie sicher, dass Sie über die erforderlichen Berechtigungen verfügen, z. B. Administratorrechte oder Eigentümerschaft für die Teamverwaltung.
  • Fehlerbehandlung: Implementieren Sie eine Fehlerbehandlung, um verschiedene HTTP-Statuscodes und Fehler angemessen zu verwalten.

Beispiel für einen Workflow

  1. Ein Team erstellen:
    • Senden Sie POST an /v1/teams mit {"slug": "example-team", "name": "Example Team"}.
  2. Benutzer einladen:
    • Verwenden Sie POST auf /v1/teams/{teamId}/members mit Benutzerdetails oder Einladungscodes.
  3. Kommen Sie ins Team:
    • Senden Sie POST an /v1/teams/join mit der Team-ID oder dem Einladungscode.
  4. Firewall-Regeln aktualisieren:
    • PUT auf /v1/firewalls mit neuer Konfiguration.
Abonnieren