Como começar

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

Confira a documentação da Apigee Edge.

Esta págica explica como começar a usar a API Advanced Security.

Funções exigidas

As seções a seguir descrevem os papéis necessários para executar tarefas usando a segurança de API avançada.

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 e visualizar 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)

Papéis necessários para detecção de abuso

A tabela abaixo mostra os papéis necessários para realizar tarefas relacionadas à detecção de abusos.

Tarefa de detecção de abuso	Papéis necessários
Ver incidentes na interface 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)

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 ações de segurança	Administrador de segurança da Apigee (roles/apigee.securityAdmin) Administrador da organização da Apigee (roles/apigee.admin)
Atualizar a configuração das 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)

Observação: para fazer as chamadas de API descritas nas seções a seguir, você precisa receber um token de acesso do OAuth 2.0, que é transmitido com as chamadas.

Gerenciar a segurança avançada de APIs para organizações com assinaturas

Para usar a segurança da API avançada como um cliente de assinatura, você precisa ativá-la na sua organização, conforme descrito nas seguintes seções:

• Acessar a configuração de complementos da Apigee
• Ativar a segurança de APIs avançada para organizações que usam assinaturas

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

• ORG é o nome da organização;
• $TOKEN é a variável de ambiente de um token de acesso do OAuth.

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.

Cuidado: essa chamada de API substitui a configuração atual dos complementos. Você precisa incluir a configuração atual de todos os complementos na solicitação mostrada abaixo para evitar que eles sejam substituídos.

Observações:

• Se você criar um novo ambiente depois de ativar a Segurança avançada da API, execute o comando abaixo novamente para ativá-la. Observe que não é necessário desativar a Segurança avançada da API antes de executar o comando novamente.
• Se você simplesmente desanexar um ambiente no qual a Segurança avançada da API está ativada em uma instância e, em seguida, reanexá-la posteriormente, não será necessário executar o comando abaixo novamente.

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

em que

• ORG é o nome da organização;
• $TOKEN é a variável de ambiente de um token de acesso do OAuth.
• em que <Other entries of your current add-ons configuration> consiste em qualquer outra entrada da configuração de complementos da Apigee atual.

Observação: a chamada de API abaixo inicia uma operação de longa duração que pode levar algum tempo para ser concluída.

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

Observação: quando você ativa a segurança avançada da API em uma organização, pode levar até um dia para que as pontuações dos proxies e destinos atuais sejam refletidas em um ambiente.

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.

Cuidado: a configuração dos complementos transmitida no corpo da solicitação substituirá a configuração atual. Veja a configuração dos complementos atuais no perfil da organização da Apigee e inclua-a no payload da solicitação.

Observação: a chamada de API abaixo inicia uma operação de longa duração que pode levar algum tempo para ser concluída.

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 Pay-as-you-go, 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.

Próximas etapas

Depois de ativar a Segurança avançada da API, veja as seguintes seções:

• Relatórios de segurança
• Avaliação de riscos
• Detecção de abuso
• Ações de segurança