L'API REST d'Esadax offre un ensemble complet de points de terminaison pour gérer diverses ressources telles que les secrets, les pare-feu, les équipes, les utilisateurs et les webhooks. Vous trouverez ci-dessous un résumé organisé de la façon d'utiliser ces points de terminaison efficacement:
Authentification
- Méthode : Assurez-vous d'avoir la méthode d'authentification nécessaire en place, qui pourrait être des jetons ou des clés API. Consultez la documentation d'Esadax pour des détails spécifiques.
Gestion des ressources
Secrets
- Retrieve Secrets: Utilisez
GET /v2/secretsavec pagination si nécessaire. - Mettre à jour le nom secret : Utilisez
PATCH /v2/secrets/{name}pour modifier le nom, en veillant à ce qu'il soit unique pour chaque utilisateur ou équipe.
Configuration du pare-feu
- Obtenir la configuration actuelle : Utilisez
GET /v1/firewalls/{configVersion}. - Mise à jour de la configuration: Utilisez
PUT /v1/firewallsavec de nouvelles règles.
Mode de défi d'attaque
- Activer/Désactiver: Utilisez
POST /v1/attack-challenge-modepour activer/désactiver le paramètre.
Équipes
- Créer une équipe: Envoyez une requête POST à
/v1/teamsavec slug et nom optionnel. - Supprimer l'équipe: Utilisez DELETE sur
/v1/teams/{teamId}avec des raisons facultatives. - Supprimer le code d'invitation: Utilisez DELETE sur
/v1/teams/{teamId}/invites/{inviteCode}. - Obtenir les infos de l'équipe: Utilisez GET sur
/v2/teams/{teamId}. - Liste des membres : Utilisez GET sur
/v2/teams/{teamId}/members, en paginant au besoin. - Inviter les utilisateurs: POST à
/v1/teams/{teamId}/membersavec email ou ID (ID a la priorité). - Rejoindre l'équipe: POST à
/v1/teams/joinavec le code d'invitation ou l'ID de l'équipe. - Mise à jour des infos de l'équipe: PATCH sur
/v2/teams/{teamId}avec de nouveaux détails. - Supprimer un membre: SUPPRIMER sur
/v1/teams/{teamId}/members/{uid}. - Demande d'accès: POST à
/v1/teams/{teamId}/request. - Confirmer la demande: PATCH sur
/v1/teams/{teamId}/members/{uid}si confirmé.
Utilisateurs
- Obtenir les informations de l'utilisateur: Utilisez GET sur
/v2/user. - Liste des événements: Utilisez GET sur
/v3/events.
Webhooks
- Créer un Webhook: POST à
/v1/webhooks. - Supprimer le Webhook: SUPPRIMER sur
/v1/webhooks/{webhookId}. - Obtenir les informations du Webhook: GET sur
/v1/webhooks/{webhookId}. - Liste des Webhooks: Utilisez GET sur
/v1/webhooks.
Les meilleures pratiques
- Permissions : Assurez-vous d'avoir les permissions nécessaires, telles que les droits d'administrateur ou la propriété pour la gestion de l'équipe.
- Gestion des erreurs: Mettre en œuvre la gestion des erreurs pour gérer les différents codes d'état HTTP et les erreurs de manière appropriée.
Exemple de flux de travail
- Créer une équipe:
- Envoyez POST à
/v1/teamsavec{"slug": "example-team", "name": "Example Team"}.
- Envoyez POST à
- Inviter les utilisateurs:
- Utilisez POST sur
/v1/teams/{teamId}/membersavec les détails de l'utilisateur ou les codes d'invitation.
- Utilisez POST sur
- Rejoignez l'équipe:
- Envoyez POST à
/v1/teams/joinavec l'ID de l'équipe ou le code d'invitation.
- Envoyez POST à
- Mettre à jour les règles du pare-feu:
- PUT à
/v1/firewallsavec une nouvelle configuration.
- PUT à
