Esadax REST API tarjoaa kattavan joukon päätepisteitä erilaisten resurssien, kuten salaisuuksien, palomuurien, tiimien, käyttäjien ja webhookien, hallintaan. Alla on järjestetty yhteenveto siitä, miten näitä päätepisteitä käytetään tehokkaasti:
Todentaminen
- Menetelmä: Varmista, että käytössäsi on tarvittava todennusmenetelmä, joka voi olla tunnus tai API-avain. Tarkista Esadaxin dokumentaatiosta tarkemmat tiedot.
Resurssinhallinta
Salaisuudet
- Hae Secrets: Käytä
GET /v2/secretskanssa sivuutus tarvittaessa. - Päivitä salainen nimi: Käytä
PATCH /v2/secrets/{name}-koodia muuttaaksesi nimen ja varmistaaksesi, että se on yksilöllinen käyttäjälle tai joukkueelle.
Palomuurin kokoonpano
- Hanki nykyinen kokoonpano: Käytä
GET /v1/firewalls/{configVersion}. - Päivitä kokoonpano: Käytä
PUT /v1/firewallsuusilla säännöillä.
Hyökkäys haastetila
- Ota käyttöön/poista käytöstä: Käytä
POST /v1/attack-challenge-modevaihtaaksesi asetusta.
Ryhmät
- Luo joukkue: Lähetä POST-pyyntö osoitteeseen
/v1/teams, jossa on slug ja valinnainen nimi. - Poista joukkue: Käytä DELETE
/v1/teams/{teamId}: ssa valinnaisilla syillä. - Poista kutsukoodi: Käytä DELETE-toimintoa
/v1/teams/{teamId}/invites/{inviteCode}:ssa. - Get Team Info: Käytä GET
/v2/teams/{teamId}. - Listaa jäsenet: Käytä GET-toimintoa
/v2/teams/{teamId}/members:ssa, sivuuttaen tarpeen mukaan. - Kutsu käyttäjiä: Lähetä viesti osoitteeseen
/v1/teams/{teamId}/memberssähköpostilla tai ID:llä (ID on etusijalla). - Liity tiimiin: Lähetä viesti osoitteeseen
/v1/teams/joinkutsukoodilla tai tiimin ID:llä. - Päivitä joukkueen tiedot: PATCH
/v2/teams/{teamId}: ssa uusilla yksityiskohdilla. - Poista jäsen: DELETE on
/v1/teams/{teamId}/members/{uid}. - Pyydä käyttöoikeutta: Lähetä viesti osoitteeseen
/v1/teams/{teamId}/request. - Vahvista pyyntö: PATCH on
/v1/teams/{teamId}/members/{uid}jos vahvistettu.
Käyttäjät
- Hanki käyttäjän tiedot: Käytä GET
/v2/user. - Luettelo Tapahtumat: Käytä GET
/v3/events.
Webhooks
- Luo Webhook: POST osoitteeseen
/v1/webhooks. - Poista Webhook: DELETE on
/v1/webhooks/{webhookId}. - Hanki Webhook Info: GET on
/v1/webhooks/{webhookId}. - Luettelo Webhooks: Käytä GET
/v1/webhooks.
Parhaat käytännöt
- Käyttöoikeudet: Varmista, että sinulla on tarvittavat käyttöoikeudet, kuten ylläpitäjän oikeudet tai omistajuus tiimin hallintaa varten.
- Virheiden käsittely: Toteuta virheiden käsittely erilaisten HTTP-tilakoodien ja virheiden hallitsemiseksi asianmukaisesti.
Esimerkki työnkulusta
- Luo joukkue:
- Lähetä POST osoitteeseen
/v1/teamskoodilla{"slug": "example-team", "name": "Example Team"}.
- Lähetä POST osoitteeseen
- Kutsu käyttäjiä:
- Käytä POSTia osoitteessa
/v1/teams/{teamId}/memberskäyttäjätiedoilla tai kutsukoodeilla.
- Käytä POSTia osoitteessa
- Liity tiimiin:
- Lähetä viesti POST numeroon
/v1/teams/joinjoukkueen ID:llä tai kutsukoodilla.
- Lähetä viesti POST numeroon
- Päivitä palomuurin säännöt:
- PUT kohteeseen
/v1/firewallsuudella kokoonpanolla.
- PUT kohteeseen
