Gerenciar o complemento "Advanced API Security"

Esta página se aplica à Apigee, mas não à Apigee híbrida.

Confira a documentação da Apigee Edge.

A Segurança avançada de API monitora continuamente suas APIs para protegê-las contra ameaças à segurança, incluindo ataques de clientes mal-intencionados e abusos. O Advanced API Security analisa o tráfego da API para identificar solicitações de API suspeitas e oferece ferramentas que podem bloquear ou sinalizar essas solicitações. Além disso, a segurança avançada da API avalia as configurações para garantir que elas atendam aos padrões de segurança e oferece recomendações para melhorias, se necessário.

Se você é um cliente da Apigee de pagamento por uso, a análise de APIs da Apigee está disponível como um complemento pago. Neste tópico, descrevemos como ativar e gerenciar o complemento de análise da API Apigee para ambientes qualificados de pagamento por uso. Para mais informações sobre como usar a segurança avançada da API após a ativação do complemento nos ambientes da Apigee, consulte Visão geral da segurança das APIs avançadas.

Disponibilidade

A análise de APIs da Apigee está disponível como um recurso de complemento pago gerenciado para cada ambiente da Apigee na implementação da Apigee. O complemento pode ser ativado em qualquer ambiente intermediário ou completo da Apigee. Não é possível ativar e usar a segurança avançada da API em ambientes Base. Para mais detalhes sobre os recursos do ambiente da Apigee, consulte Comparação de tipos de ambiente.

Papéis e permissões necessárias

Para receber as permissões necessárias para gerenciar o complemento de análise da API de segurança, peça ao administrador para conceder a você o papel de administrador do ambiente da Apigee (apigee.environment.admin) do IAM no projeto. Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

Esse papel predefinido contém as permissões necessárias para gerenciar o complemento Segurança da API avançada. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As permissões abaixo são necessárias para gerenciar o complemento "Segurança da API avançada":

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Depois que o complemento for ativado, poderá ser necessário usar outros papéis para realizar tarefas usando a segurança avançada de APIs. Para mais informações, consulte Papéis necessários.

Ativar o complemento "Segurança das APIs avançadas"

É possível ativar o complemento "Segurança avançada das APIs" para uma Intermediário ou Abrangente Ambiente Apigee usando a IU da Apigee no console do Google Cloud ou usando a API, conforme descrito nas seções a seguir.

Apigee no console do Google Cloud

Para ativar o complemento Advanced API Security no console do Google Cloud:

  1. Abra a página Apigee no console.

    Acessar a Apigee

  2. Selecione o projeto com a organização de pagamento por uso e os ambientes que você quer gerenciar.
  3. Selecione Complementos > Segurança avançada da API para abrir a página Complemento de segurança da API avançada.
  4. No painel Gerenciar o complemento Advanced API Security, marque a caixa de seleção do ambiente (ou dos ambientes) em que você quer ativar o complemento.
  5. Clique em Ativar selecionadas.
  6. Quando a ativação dos ambientes selecionados for concluída, o Status do ambiente exibirá Ativado.
  7. Selecionar Segurança avançada de APIs para ver opções da página para usar seus dados de segurança, incluindo Avaliação de risco , Detecção de abuso , Relatórios de segurança e Ações de segurança de dois minutos. Os dados de segurança avançada da API podem levar até 10 minutos para serem mostrados.

API Apigee

Para ativar o complemento Advanced API Security usando a API Apigee, digite o seguinte comando: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"api_security_enabled":true}'

Em que:

  • ORG_NAME é o nome da organização de pagamento por utilização da Apigee em que você quer adicionar a segurança avançada de APIs aos ambientes qualificados.
  • ENV_NAME é o nome do ambiente da Apigee em que você quer ativar o complemento Advanced API Security.

Após a conclusão da ativação, clique em Segurança avançada da API para ver as opções da página de uso dos seus dados de segurança, incluindo Avaliação de risco, Detecção de abuso, Relatórios de segurança e Ações de segurança. Os dados de segurança avançada da API podem levar até 10 minutos para aparecer na interface ou ficam disponíveis por uma chamada de API.

O processo de ativação do complemento "Segurança das APIs avançadas" pode levar até 15 minutos. Depois de ativados, os dados de análise do ambiente são retidos por 14 meses. É possível acessar os dados históricos do ambiente nas páginas Segurança da API avançada no console, desde que o complemento esteja ativado.

O faturamento para uso do complemento Segurança de APIs avançada começa quando a ativação do complemento é iniciada.

Desativar o complemento "Segurança das APIs avançadas"

É possível desativar o complemento de segurança da API avançada para um ambiente da Apigee intermediário ou completo usando a IU da Apigee no console do Google Cloud ou a API, conforme descrito nas próximas seções.

Apigee no console do Cloud

Para desativar o complemento Advanced API Security no console do Google Cloud:

  1. Abra a página Apigee no console.

    Acessar a Apigee

  2. Selecione o projeto com a organização de pagamento por uso e os ambientes que você quer gerenciar.
  3. Selecione Complementos > Segurança avançada da API para abrir a página Complemento de segurança da API avançada.
  4. No painel Gerenciar o complemento Advanced API Security, marque a caixa de seleção do ambiente (ou dos ambientes) em que você quer desativar o complemento.
  5. Clique em Desativar selecionados.
  6. Quando a desativação for concluída, o Status exibirá Desativado para cada ambiente.

API Apigee

Para desativar o complemento Advanced API Security usando a API Apigee, digite o seguinte comando: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"api_security_enabled":false}'

Em que:

  • ORG_NAME é o nome da organização de pagamento por utilização da Apigee em que você quer desativar a segurança avançada da API em ambientes qualificados.
  • ENV_NAME é o nome do ambiente da Apigee em que você quer desativar o complemento Advanced API Security.

Conferir o status do complemento "Segurança das APIs avançadas" em um ambiente

É possível verificar o status do complemento de análise da API Apigee para um ambiente da Apigee intermediário ou abrangente usando a IU da Apigee no console do Google Cloud ou usando a API, conforme descrito nas seções a seguir.

Apigee no console do Google Cloud

Para ver o status do complemento Advanced API Security em um ambiente usando o console do Google Cloud:

  1. Abra a página Apigee no console.

    Acessar a Apigee

  2. Selecione o projeto com a organização de pagamento por uso e os ambientes que você quer gerenciar.
  3. Selecione Complementos > Segurança avançada da API para abrir a página Complemento de segurança da API avançada.
  4. No painel Manage Advanced API Security, uma lista de ambientes é exibida.
  5. Na coluna de status, é possível ver se o complemento está Ativado ou Desativado em cada ambiente intermediário ou abrangente. Os ambientes de base não exibem nenhum status.

API Apigee

Para visualizar o status do complemento Apigee API Analytics em um ambiente usando a API Apigee, digite o seguinte comando:

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json"

Em que:

  • ORG_NAME é o nome da organização de pagamento por uso da Apigee.
  • ENV_NAME é o nome do ambiente da Apigee.

A resposta retorna um objeto ApiSecurityConfig que representa o status atual do complemento.

Gerenciar seus dados da segurança avançada de APIs

Depois que o complemento "Segurança da API avançada" é ativado em um ambiente, os dados de segurança dele são mantidos por 14 meses. É possível acessar os relatórios de segurança do ambiente na página Relatórios de segurança do console, mas não é possível criar novos relatórios.

Se você desativar o complemento "Segurança da API avançada" em um ambiente, os dados de segurança dele serão excluídos após 30 dias. Se você reativar o complemento no mesmo ambiente até 30 dias após a desativação, poderá recuperar o acesso aos dados de análise do ambiente durante o período de armazenamento de 14 meses. Nenhum dado será restaurado se o complemento for reativado para o ambiente após 30 dias.

Se você quiser manter os relatórios de segurança de qualquer ambiente após o período de armazenamento de 14 meses, recomendamos exportar e salvar os dados em outro local. Também é possível exportar os dados da Segurança avançada da API antes de desativar o complemento ou em um período de 30 dias após a desativação. É possível exportar os relatórios de segurança usando o botão Exportar na página Relatórios de segurança do console ou fazer o download de um relatório usando a API Security Reporting.