Vamos começar

Esta página se aplica a Apigee e à Apigee híbrida.

Confira Apigee Edge documentação.

Esta página explica como começar a usar o Advanced API Security para organizações com assinatura e pagamento por uso.

Papéis e permissões necessárias

As seções a seguir descrevem os papéis e permissões necessários para executar tarefas usando Advanced API Security.

Papéis necessários para relatórios de segurança

A tabela abaixo mostra os papéis necessários para realizar tarefas relacionadas aos relatórios de segurança.

Tarefa de relatório de segurança Papéis necessários
Ativar ou desativar a Segurança avançada da API Administrador da organização da Apigee (roles/apigee.admin)
Criar relatórios Administrador da organização da Apigee (roles/apigee.admin)
Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Ver relatórios Leitor de segurança da Apigee (roles/apigee.securityViewer)
Administrador de segurança da Apigee (roles/apigee.securityAdmin)

Papéis necessários para avaliação de risco

A tabela abaixo mostra os papéis necessários para executar tarefas relacionadas à avaliação de risco.

Tarefa de avaliação de riscos Papéis necessários
Criar, atualizar ou excluir um perfil de segurança personalizado Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Administrador da organização da Apigee (roles/apigee.admin)
Anexar ou remover um perfil de segurança Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Administrador da organização da Apigee (roles/apigee.admin)
Conferir pontuações de segurança Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Leitor de segurança da Apigee (roles/apigee.securityViewer)
Administrador da organização da Apigee (roles/apigee.admin)
Listar todos os perfis de segurança ou obter um perfil Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Leitor de segurança da Apigee (roles/apigee.securityViewer)
Administrador da organização da Apigee (roles/apigee.admin)
Criar, atualizar ou excluir uma condição de monitoramento de segurança Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Administrador da organização da Apigee (roles/apigee.admin)
Listar e visualizar condições de monitoramento de segurança Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Leitor de segurança da Apigee (roles/apigee.securityViewer)
Administrador da organização da Apigee (roles/apigee.admin)
Listar e visualizar métricas de condição de monitoramento de segurança Administrador do Monitoring (roles/monitoring.admin)
Editor de monitoramento (roles/monitoring.editor)
Criar, atualizar ou excluir alertas de monitoramento Consulte Papéis necessários (para alertas de segurança)
Ver alertas de monitoramento Consulte Incidentes para políticas de alertas baseados em métricas: antes de começar

Papéis e permissões necessários para detecção de abuso

A tabela abaixo mostra os papéis e permissões necessários para realizar tarefas relacionadas a detecção de abusos.

Tarefa de detecção de abuso Papéis e permissões necessárias
Ver incidentes na UI de detecção de abusos Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Leitor de segurança da Apigee (roles/apigee.securityViewer)
Administrador da organização da Apigee (roles/apigee.admin)
Ver insights de IA generativa de incidentes Permissão cloudaicompanion.instances.generateText
Ativar ou desativar uma organização em modelos de machine learning para detecção de abuso Permissão apigee.securitySettings.update
Apigee Administrador de segurança (roles/apigee.securityAdmin)
Apigee Administrador da organização (roles/apigee.admin)

Papéis necessários para ações de segurança

A tabela abaixo mostra os papéis necessários para realizar tarefas relacionadas às ações de segurança.

Tarefa de ação de segurança Papéis necessários
Criar, editar ou excluir configurações de ações de segurança Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Administrador da organização da Apigee (roles/apigee.admin)
Ver ou listar ações de segurança Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Leitor de segurança da Apigee (roles/apigee.securityViewer)
Administrador da organização da Apigee (roles/apigee.admin)
Verificar o estado da aplicação obrigatória Administrador de segurança da Apigee (roles/apigee.securityAdmin)
Leitor de segurança da Apigee (roles/apigee.securityViewer)
Administrador da organização da Apigee (roles/apigee.admin)

Gerenciar o Advanced API Security para organizações com assinaturas

Para usar o Advanced API Security como um cliente de assinatura, ele precisa fazer parte dos seus direitos de assinatura. Consulte os direitos da Apigee. Para adicionar o Advanced API Security aos seus direitos, entre em contato com a equipe de vendas da Apigee.

Depois que o Advanced API Security fizer parte dos seus direitos, ative-o na sua organização:

Se você não tiver certeza se está usando uma organização da Apigee por assinatura ou pagamento por uso, entre em contato com o administrador da Apigee.

Acessar a configuração de complementos da Apigee

Para ativar a segurança da API avançada para sua organização de assinatura, primeiro você precisa conseguir a configuração atual dos complementos da Apigee usando a chamada de API a seguir. Isso também informará se a Segurança avançada da API já está ativada.

curl "https://apigee.googleapis.com/v1/organizations/ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

onde

Isso retorna informações básicas sobre sua organização, incluindo uma seção para a configuração de complementos da Apigee que começa com a linha:

"addonsConfig": {

Verifique se esta seção contém a seguinte entrada:

"apiSecurityConfig": {
          "enabled": true
      }

Em caso afirmativo, a segurança avançada da API já está ativada na organização. Caso contrário, você precisará ativá-lo, conforme descrito a seguir.

Ativar a segurança de APIs avançada para organizações que usam assinaturas

Para ativar a segurança avançada de API em uma organização de assinatura com a configuração padrão, emita uma solicitação POST como a mostrada abaixo.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      }
      <Other entries of your current add-ons configuration>
    }
  }'

onde

Por exemplo, se a configuração de complementos atual for

"addonsConfig": {
  "integrationConfig": {
      "enabled":true
  },
  "monetizationConfig": {
      "enabled":true
  }
},

o comando para ativar a Segurança avançada da API seria 

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      },
      "integrationConfig": {
          "enabled": true
      },
      "monetizationConfig": {
          "enabled": true
      }
    }
  }'

Depois de enviar a solicitação, você verá uma resposta como esta:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Desativar a segurança de APIs avançada para organizações com assinatura

Se por algum motivo você precisar desativar a segurança avançada da API na sua organização de assinatura, emita uma solicitação POST, transmitindo a configuração de complementos no corpo da solicitação, conforme mostrado abaixo.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": false
      }
     <Include current add-ons configuration>
    }
  }'

Veja a seguir um exemplo de resposta que mostra que a operação está em andamento: 

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Para mais informações, consulte Configurar a API de complementos da organização.

Gerenciar a segurança avançada de APIs para organizações com pagamento por uso

Se você é um cliente de pagamento por uso, pode ativar o uso da Segurança avançada da API como um complemento pago. Para mais informações sobre como ativar o complemento "Segurança avançada da API" para seus ambientes Apigee intermediário ou abrangente, consulte Gerenciar o complemento Segurança da API avançada.

Se você não tiver certeza se está usando uma organização da Apigee por assinatura ou pagamento por uso, entre em contato com o administrador da Apigee.

Gerenciar o Advanced API Security para organizações de avaliação

O complemento Advanced API Security é incluído automaticamente nas organizações de teste (avaliação) da Apigee, mas é necessário ativá-lo.

Para ativá-lo, siga as instruções em Ativar o Advanced API Security para organizações que usam assinaturas.

Se você precisar desativá-lo, siga as instruções em Desativar o Advanced API Security para organizações com assinatura.

Configurar o Advanced API Security usando o Terraform

A Apigee oferece suporte ao uso do Terraform para gerenciar algumas funcionalidades da segurança avançada da API.

Por exemplo, é possível usar o Terraform para configurar:

Para informações sobre a funcionalidade com suporte no momento, consulte a seção Apigee do Registro do Terraform. Os nomes de recursos relacionados à segurança avançada da API começam com google_apigee_security.

Para informações gerais sobre como usar o Terraform com Apigee, consulte Usar Terraform com a Apigee.

Próximas etapas

Depois de ativar o Advanced API Security, consulte: