API REST Defender for Cloud Apps

Este artigo descreve como interagir com Defender for Cloud Apps através de HTTPS.

A API de Microsoft Defender for Cloud Apps fornece acesso programático a Defender for Cloud Apps através de pontos finais da API REST. As aplicações podem utilizar a API para realizar operações de leitura e atualização em Defender for Cloud Apps dados e objetos. Por exemplo, a API de Defender for Cloud Apps suporta as seguintes operações comuns para um objeto de utilizador:

• Carregar ficheiros de registo para a deteção da cloud
• Gerar scripts de blocos
• Listar atividades e alertas
• Dispensar ou resolver alertas

Estrutura do URL da API

Para utilizar a API de Defender for Cloud Apps, primeiro tem de obter o URL da API a partir do seu inquilino. O URL da API utiliza o seguinte formato: https://<portal_url>/api/<endpoint>.

Para obter o URL da API Defender for Cloud Apps para o seu inquilino, siga os seguintes passos:

1. No Portal do Microsoft Defender, selecione Definições. Em seguida, selecione Aplicações na Cloud. Em Sistema, selecione Acerca de.

2. No Defender for Cloud Apps sobre o ecrã, pode ver o URL da API.

   

Assim que tiver o URL da API, adicione-lhe o /api sufixo para obter o URL da API. Por exemplo, se o URL do portal for https://mytenant.us2.contoso.com, o URL da API será https://mytenant.us2.portal.cloudappsecurity.com/api.

Tokens de API

Defender for Cloud Apps requer um token de API no cabeçalho de todos os pedidos de API para o servidor, como o seguinte:

Authorization: Token <your_token_key>

Onde <your_token_key> está o token pessoal da API.

Para obter mais informações sobre tokens de API, veja Managing API tokens (Gerir tokens de API).

Tokens de API – exemplo

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

Que ações são suportadas?

A tabela seguinte descreve as ações suportadas:

Em que Recurso representa um grupo de entidades relacionadas.

Que tipos de campo são suportados?

A tabela seguinte descreve os tipos de campo suportados:

Carimbos de data/hora

As menções aos carimbos de data/hora na API de Defender for Cloud Apps referem-se ao carimbo de data/hora Unix em milissegundos. Este carimbo de data/hora é determinado pelo número de milissegundos desde 1970-01-01 0:00:00. Pode utilizar o cmdlet do PowerShell get-date para converter datas em carimbos de data/hora.

Limites

Pode optar por limitar os pedidos ao fornecer um parâmetro de limite no pedido.

Os seguintes métodos são suportados para fornecer o parâmetro de limite:

• Codificado com URL (com Content-Type: application/x-www-form-urlencoded cabeçalho)
• Dados do formulário
• Corpo JSON (com Content-Type: multipart/form-data e um cabeçalho de limite adequado)

Filtros

Quando tiver um grande número de resultados, será útil ajustar os pedidos através de filtros. Esta secção descreve a estrutura de e os operadores que podem ser utilizados com filtros.

Estrutura

Alguns dos nossos pontos finais de API suportam filtros ao executar consultas. Nas respetivas secções relevantes, encontrará uma referência que lista todos os campos filtráveis disponíveis e operadores suportados para esse recurso.

A maioria dos filtros suporta vários valores para lhe fornecer consultas poderosas. Ao combinar filtros e operadores, utilizamos AND como o operador lógico entre os filtros.

Filtros - exemplo

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
}'

Operadores

A tabela seguinte descreve os operadores suportados:

Passos seguintes

Se tiver algum problema, estamos aqui para ajudar. Para obter assistência ou suporte para o problema do produto, abra um pedido de suporte.