La API REST de Esadax ofrece un conjunto completo de puntos finales para administrar varios recursos como secretos, firewalls, equipos, usuarios y webhooks. A continuación se muestra un resumen organizado de cómo usar estos puntos finales de manera efectiva:
Autenticación
- Método: Asegúrese de tener el método de autenticación necesario, que podría ser tokens o claves de API. Consulte la documentación de Esadax para obtener detalles específicos.
Gestión de los recursos
Secrets
- Recupera Secretos: Usa
GET /v2/secretscon paginación si es necesario. - Actualizar nombre secreto: Usa
PATCH /v2/secrets/{name}para cambiar el nombre, asegurándote de que sea único por usuario o equipo.
Configuración de Firewall
- Obtener la configuración actual: Utilice
GET /v1/firewalls/{configVersion}. - Configuración de actualización: Utilice
PUT /v1/firewallscon nuevas reglas.
Modo de desafío de ataque
- Activar/Desactivar: Utilice
POST /v1/attack-challenge-modepara alternar la configuración.
Equipos
- Crear equipo: Envía una solicitud POST a
/v1/teamscon slug y nombre opcional. - Eliminar Equipo: Usa DELETE en
/v1/teams/{teamId}con razones opcionales. - Eliminar Código de Invitación: Usa DELETE en
/v1/teams/{teamId}/invites/{inviteCode}. - Obtener información del equipo: Use GET en
/v2/teams/{teamId}. - Lista de miembros: Use GET en
/v2/teams/{teamId}/members, paginando según sea necesario. - Invitar Usuarios: POST a
/v1/teams/{teamId}/memberscon email o ID (ID tiene prioridad). - Únete al equipo: POST a
/v1/teams/joincon el código de invitación o ID del equipo. - Actualización de la información del equipo: PARCHE en
/v2/teams/{teamId}con nuevos detalles. - Eliminar Miembro: DELETE en
/v1/teams/{teamId}/members/{uid}. - Solicitar Acceso: POST a
/v1/teams/{teamId}/request. - Confirmar Solicitud: PARCHE en
/v1/teams/{teamId}/members/{uid}si se confirma.
Usuarios
- Obtener información del usuario: Utilice GET en
/v2/user. - Lista de Eventos: Use GET en
/v3/events.
Webhooks
- Crear Webhook: POST a
/v1/webhooks. - Eliminar Webhook: DELETE en
/v1/webhooks/{webhookId}. - Obtener información de Webhook: GET en
/v1/webhooks/{webhookId}. - Lista de Webhooks: Utilice GET en
/v1/webhooks.
Las mejores prácticas
- Permisos: Asegúrate de tener los permisos necesarios, como derechos de administrador o propiedad para la administración del equipo.
- Manejo de errores: Implemente el manejo de errores para administrar diferentes códigos de estado HTTP y errores adecuadamente.
Ejemplo de flujo de trabajo
- Crear un equipo:
- Envíe POST a
/v1/teamscon{"slug": "example-team", "name": "Example Team"}.
- Envíe POST a
- Invitar a usuarios:
- Utilice POST en
/v1/teams/{teamId}/memberscon los detalles del usuario o códigos de invitación.
- Utilice POST en
- Únete al equipo:
- Envía POST a
/v1/teams/joincon el ID del equipo o el código de invitación.
- Envía POST a
- Actualizar reglas de firewall:
- PUT a
/v1/firewallscon nueva configuración.
- PUT a
