Vamos começar

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

Confira a documentação da Apigee Edge.

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

Papéis e permissões necessárias

As seções a seguir descrevem os papéis e as permissões necessárias para realizar 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.

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.

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

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

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.

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

Para usar a Segurança avançada de API como um cliente de assinatura, ela precisa fazer parte dos seus direitos de assinatura. Consulte Direitos da Apigee. Para adicionar o Advanced API Security aos seus direitos, entre em contato com a equipe de vendas da Apigee.

Depois que a segurança avançada da API fizer parte dos seus direitos, ative-a na sua organização:

• 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.

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

• 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.

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 a segurança avançada de APIs 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 ativar, siga as instruções em Ativar a segurança avançada da API para organizações que usam assinaturas.

Se precisar desativar, siga as instruções em Desativar a segurança avançada da API para organizações com assinatura.

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