Defender for Cloud Apps REST-ohjelmointirajapinta

Artikkeli
11/28/2024

Tässä artikkelissa kuvataan, miten voit käsitellä Defender for Cloud Apps HTTPS:n kautta.

Microsoft Defender for Cloud Apps-ohjelmointirajapinta tarjoaa Defender for Cloud Apps ohjelmallisen käytön REST-ohjelmointirajapinnan päätepisteiden kautta. Sovellukset voivat ohjelmointirajapinnan avulla suorittaa luku- ja päivitystoimintoja Defender for Cloud Apps tiedoille ja objekteille. Esimerkiksi Defender for Cloud Apps-ohjelmointirajapinta tukee seuraavia yleisiä käyttäjäobjektin toimintoja:

Lataa lokitiedostot pilvietsintää varten
Lohkokomentosarjojen luominen
Luettelotoiminnot ja hälytykset
Hylkää tai ratkaise hälytyksiä

Ohjelmointirajapinnan URL-osoitteen rakenne

Jotta voit käyttää Defender for Cloud Apps-ohjelmointirajapintaa, sinun on ensin hankittava ohjelmointirajapinnan URL-osoite vuokraajastasi. Ohjelmointirajapinnan URL-osoite käyttää seuraavaa muotoa: https://<portal_url>/api/<endpoint>.

Saat vuokraajan Defender for Cloud Apps-ohjelmointirajapinnan URL-osoitteen seuraavasti:

Valitse Microsoft Defender portaalissa Asetukset. Valitse sitten Pilvisovellukset. Valitse Järjestelmä-kohdastaTietoja.
Tietoja Defender for Cloud Apps -näytössä on ohjelmointirajapinnan URL-osoite.

Kun sinulla on ohjelmointirajapinnan URL-osoite, lisää /api siihen jälkiliite ohjelmointirajapinnan URL-osoitteen hankkimiseksi. Jos esimerkiksi portaalin URL-osoite on https://mytenant.us2.contoso.com, ohjelmointirajapinnan URL-osoite on https://mytenant.us2.portal.cloudappsecurity.com/api.

Ohjelmointirajapinnan tunnukset

Defender for Cloud Apps edellyttää ohjelmointirajapintatunnusta kaikkien palvelimelle määritettyjen ohjelmointirajapintapyyntöjen otsikossa, esimerkiksi seuraavasti:

Authorization: Token <your_token_key>

Missä <your_token_key> henkilökohtainen ohjelmointirajapinnan tunnus on.

Lisätietoja ohjelmointirajapintatunnuksista on kohdassa Ohjelmointirajapintatunnusten hallinta.

Ohjelmointirajapinnan tunnukset – esimerkki

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint"

Mitä toimintoja tuetaan?

Seuraavassa taulukossa kuvataan tuetut toiminnot:

Resurssi	HTTP-verbit	URI-reitit
Toimintaa	HAE tai JULKAISE	/api/v1/activities/
Ilmoitukset	HAE tai JULKAISE	/api/v1/alerts/
Tietojen rikastaminen	HAE, JULKAISE tai POISTA	/ohjelmointirajapinta/aliverkko/
Yhteisöt	HAE tai JULKAISE	/api/v1/entities/
Tiedostot	HAE tai JULKAISE	/api/v1/files/

Jossa Resurssi edustaa joukkoa liittyviä entiteettejä.

Mitä kenttätyyppejä tuetaan?

Seuraavassa taulukossa kuvataan tuetut kenttätyypit:

Kenttä	Kuvaus
merkkijono	Tekstimerkkijono
Boolean	Totuusarvo, joka edustaa arvoa tosi/epätosi
kokonaisluku	32-bittinen allekirjoitettu kokonaisluku
aikaleima	Millisekuntia aikakaudesta

Aikaleimat

Defender for Cloud Apps-ohjelmointirajapinnan aikaleimat viittaavat Unix-aikaleimaan millisekunteina. Tämä aikaleima määritetään millisekunteina sitten 1970-01-01 0:00:00. Voit muuntaa päivämäärät aikaleimaksi get-date PowerShellin cmdlet-komennolla.

Rajoitukset

Voit rajoittaa pyyntöjäsi antamalla pyynnössä rajaparametrin.

Rajaparametrin antamiseen tuetaan seuraavia menetelmiä:

URL-koodattu (otsikon kanssa Content-Type: application/x-www-form-urlencoded )
Lomakkeen tiedot
JSON-leipäteksti (ja Content-Type: multipart/form-data asianmukainen reunaotsikko)

Huomautus

Jos rajoitusta ei anneta, oletusarvo on 100.
Kaikkien ohjelmointirajapintatunnuksella tehtyjen pyyntöjen vastaukset on rajoitettu enintään 100 kohteeseen.
Kaikkien ohjelmointirajapintapyyntöjen rajoitus on 30 pyyntöä minuutissa vuokraajaa kohden.

Suodattimet

Kun tuloksia on paljon, voit hienosäätää pyyntöjä suodattimien avulla. Tässä osiossa kuvataan suodattimien kanssa käytettävien operaattoreiden ja operaattoreiden rakenne.

Rakenne

Jotkin ohjelmointirajapinnan päätepisteet tukevat suodattimia kyselyitä suoritettaessa. Niiden asiaankuuluvissa osioissa on viittaus, jossa luetellaan kaikki käytettävissä olevat suodatettavat kentät ja kyseisen resurssin tuetut operaattorit.

Useimmat suodattimet tukevat useita arvoja tehokkaiden kyselyjen tarjoamiseksi. Yhdistäessämme suodattimia ja operaattoreita käytämme AND-funktiota loogisena operaattorina suodattimien välillä.

Suodattimet – esimerkki

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint" -d '{
  "filters": {
    "some.field": {
      "eq": ["value1", "value2"],
      "isset": true
    },
    "some.field2": {
      "gte": 5
    }
  },
  "skip": 5,
  "limit": 10
}'

Toimijoiden

Huomautus

Kaikki operaattorit eivät ole yhteensopivia kaikkien suodattimien kanssa.

Seuraavassa taulukossa kuvataan tuetut operaattorit:

Operaattori	Vastaustyyppi	Kuvaus
Sisältää	merkkijonoluettelo	Palauttaa kaikki oleelliset tietueet, jotka sisältävät jonkin annetuista merkkijonoista
2. kk	arvoluettelo	Palauttaa kaikki tietueet, jotka sisältävät yhden arvon, joka ei ole yhtä suuri kuin annetut arvot
descendantof	arvoluettelo	Palauttaa kaikki oleelliset tietueet, jotka vastaavat niiden arvoja tai alikohteita
doesnotstartwith	merkkijonoluettelo	Palauttaa kaikki oleelliset tietueet, jotka eivät ala annetuilla merkkijonoilla
päättyy ja	merkkijonoluettelo	Palauttaa kaikki oleelliset tietueet, jotka päättyvät yhteen annetuista merkkijonoista
Eq	arvoluettelo	Palauttaa kaikki oleelliset tietueet, jotka sisältävät yhden annetuista arvoista
gt gt	yksittäinen arvo	Palauttaa kaikki tietueet, joiden arvo on suurempi kuin annettu arvo
Gte	yksittäinen arvo	Palauttaa kaikki tietueet, joiden arvo on suurempi tai yhtä suuri kuin annettu arvo
gte_ndays	numero	Palauttaa kaikki tietueet, joiden päivämäärä on myöhempi kuin N päivää sitten
ei ole määritetty	Boolean	Kun asetuksena on "tosi", palauttaa kaikki olennaiset tietueet, joilla ei ole arvoa määritetyssä kentässä
isset	Boolean	Kun arvoksi on määritetty tosi, palauttaa kaikki oleelliset tietueet, joilla on arvo määritetyssä kentässä
lt	yksittäinen arvo	Palauttaa kaikki tietueet, joiden arvo on pienempi kuin annettu arvo
lte	yksittäinen arvo	Palauttaa kaikki tietueet, joiden arvo on pienempi tai yhtä suuri kuin annettu arvo
lte_ndays	numero	Palauttaa kaikki tietueet, joiden päivämäärä on varhaisempi kuin N päivää sitten
ncontains	merkkijonoluettelo	Palauttaa kaikki oleelliset tietueet, jotka eivät sisällä jotakin annetuista merkkijonoista
ndescendantof	arvoluettelo	Palauttaa kaikki tietueet, jotka eivät vastaa niiden arvoja tai alikohteita
neq	arvoluettelo	Palauttaa kaikki oleelliset tietueet, jotka eivät sisällä kaikkia annettuja arvoja
etäisyys	"start"- ja "end"-kenttiä sisältävien objektien luettelo	Palauttaa kaikki tietueet yhdessä annetuista alueista
alkaa	merkkijonoluettelo	Palauttaa kaikki oleelliset tietueet alkaen yhdestä annetusta merkkijonosta
alkaa käytössä	merkkijono	Palauttaa kaikki asianmukaiset tietueet alkaen annetusta merkkijonosta
Tekstiviesti	merkkijono	Suorittaa kaikkien tietueiden tekstihaun

Seuraavat vaiheet

Ohjelmointirajapinnan todentaminen

Jos kohtaat ongelmia, olemme täällä auttamassa. Jos haluat apua tai tukea tuoteongelmaasi varten, avaa tukipyyntö.

Jaa