Esta página foi traduzida pela API Cloud Translation.

Começar

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Esta página explica como começar a usar a segurança avançada da API para organizações de subscrição e pagamento conforme o uso.

Funções e autorizações necessárias

As secções seguintes descrevem as funções e as autorizações necessárias para realizar tarefas através da segurança avançada da API.

Funções necessárias para relatórios de segurança

A tabela abaixo mostra as funções necessárias para realizar tarefas relacionadas com relatórios de segurança.

Tarefa de relatório de segurança	Funções necessárias
Ative ou desative a segurança avançada da API	Administrador da organização do Apigee (`roles/apigee.admin`)
Crie relatórios	Apigee Organization Admin (`roles/apigee.admin`) Apigee Security Admin (`roles/apigee.securityAdmin`)
Ver relatórios	Apigee Security Viewer (`roles/apigee.securityViewer`) Apigee Security Admin (`roles/apigee.securityAdmin`)

Funções necessárias para a avaliação de risco

A tabela abaixo mostra as funções necessárias para realizar tarefas relacionadas com a avaliação de risco.

Tarefa de avaliação de risco	Funções necessárias
Crie, atualize ou elimine um perfil de segurança personalizado	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Organization Admin (`roles/apigee.admin`)
Anexe ou desanexe um perfil de segurança	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Organization Admin (`roles/apigee.admin`)
Veja as pontuações de segurança	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Security Viewer (`roles/apigee.securityViewer`) Apigee Organization Admin (`roles/apigee.admin`)
Apresente todos os perfis de segurança ou obtenha um perfil	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Security Viewer (`roles/apigee.securityViewer`) Apigee Organization Admin (`roles/apigee.admin`)
Crie, atualize ou elimine uma condição de monitorização de segurança	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Organization Admin (`roles/apigee.admin`)
Liste e veja as condições de monitorização de segurança	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Security Viewer (`roles/apigee.securityViewer`) Apigee Organization Admin (`roles/apigee.admin`)
Liste e veja as métricas de condições de monitorização de segurança	Administrador de monitorização (`roles/monitoring.admin`) Editor de monitorização (`roles/monitoring.editor`)
Crie, atualize ou elimine alertas de monitorização	Consulte Funções necessárias (para alertas de segurança)
Veja os alertas de monitorização	Consulte Incidentes para políticas de alerta baseadas em métricas: antes de começar

Funções e autorizações necessárias para a deteção de abusos

A tabela abaixo mostra as funções e as autorizações necessárias para realizar tarefas relacionadas com a deteção de abuso.

Tarefa de deteção de abuso	Funções e autorizações necessárias
Veja incidentes na IU de deteção de abusos	Apigee Administrador de segurança (`roles/apigee.securityAdmin`) Apigee Visitante de segurança (`roles/apigee.securityViewer`) Apigee Administrador da organização (`roles/apigee.admin`)
Veja estatísticas de IA generativa sobre incidentes	Autorização de `cloudaicompanion.instances.generateText`
Ative ou desative os modelos de aprendizagem automática para deteção de abuso para uma organização	`apigee.securitySettings.update` Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Organization Admin (`roles/apigee.admin`)

Funções necessárias para ações de segurança

A tabela abaixo mostra as funções necessárias para realizar tarefas relacionadas com ações de segurança.

Tarefa de ação de segurança	Funções necessárias
Crie, edite ou elimine configurações de ações de segurança	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Organization Admin (`roles/apigee.admin`)
Ver ou listar ações de segurança	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Security Viewer (`roles/apigee.securityViewer`) Apigee Organization Admin (`roles/apigee.admin`)
Verifique o estado da aplicação	Apigee Security Admin (`roles/apigee.securityAdmin`) Apigee Security Viewer (`roles/apigee.securityViewer`) Apigee Organization Admin (`roles/apigee.admin`)

Faça a gestão da segurança avançada da API para organizações de subscrição

Para usar a segurança avançada da API como cliente de subscrição, a segurança avançada da API tem de fazer parte dos seus direitos de subscrição. Consulte os direitos do Apigee. Para adicionar a segurança avançada de APIs às suas autorizações, contacte a equipa de vendas do Apigee.

Assim que a segurança avançada da API fizer parte das suas autorizações, ative-a na sua organização:

Obtenha a configuração dos suplementos do Apigee
Ative a segurança avançada da API para organizações de subscrições

Se não tiver a certeza de que está a usar uma organização do Apigee por subscrição ou de pagamento conforme o uso, contacte o administrador da sua organização do Apigee.

Obtenha a configuração dos suplementos do Apigee

Para ativar a segurança avançada da API para a sua organização de subscrições, primeiro tem de obter a configuração atual dos suplementos do Apigee através da seguinte chamada API. Isto também indica 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 sua organização.
$TOKEN é a variável de ambiente para uma chave de acesso OAuth.

Esta chamada devolve informações básicas acerca da sua organização, incluindo uma secção para a configuração dos suplementos do Apigee que começa com a linha:

"addonsConfig": {

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

"apiSecurityConfig": {
          "enabled": true
      }

Se for o caso, a segurança avançada de APIs já está ativada na organização. Caso contrário, tem de a ativar, conforme descrito em seguida.

Ative a segurança avançada da API para organizações de subscrição

Para ativar a segurança avançada da API numa organização de subscrição com a configuração predefinida, emita um pedido POST como o apresentado 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 sua organização.
$TOKEN é a variável de ambiente para uma chave de acesso OAuth.
<Other entries of your current add-ons configuration> consiste em quaisquer outras entradas da sua configuração de suplementos do Apigee atual.

Por exemplo, se a configuração atual dos suplementos 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 o pedido, vê uma resposta semelhante à seguinte:

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

Desative a segurança avançada da API para organizações de subscrição

Se, por algum motivo, precisar de desativar a segurança avançada da API na sua organização de subscrição, pode fazê-lo emitindo um pedido POST, transmitindo a configuração dos suplementos no corpo do pedido, 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>
    }
  }'

Segue-se um exemplo da resposta que mostra que a operação está em curso:

{
  "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 o artigo Configure a API de suplementos da organização.

Faça a gestão da segurança avançada da API para organizações com pagamento conforme o uso

Se for cliente de Pay-as-you-go, pode ativar a segurança avançada da API como um suplemento pago. Para mais informações sobre como ativar o suplemento de segurança avançada da API para os seus ambientes intermédios ou abrangentes do Apigee, consulte o artigo Faça a gestão do suplemento de segurança avançada da API.

Se não tiver a certeza de que está a usar uma organização do Apigee por subscrição ou de pagamento conforme o uso, contacte o administrador da sua organização do Apigee.

Faça a gestão da segurança avançada da API para organizações de avaliação

O suplemento Advanced API Security está incluído automaticamente nas organizações de avaliação do Apigee, mas tem de o ativar.

Para a ativar, siga as instruções no artigo Ative a segurança avançada da API para organizações de subscrição.

Se precisar de desativá-la, siga as instruções em Desative a segurança avançada da API para organizações de subscrição.

Configure a segurança avançada da API com o Terraform

O Apigee suporta a utilização do Terraform para gerir algumas funcionalidades de segurança avançada de APIs. (Consulte Terraform on Google Cloud para ver informações sobre a configuração e a utilização do Terraform com o Google Cloud e o Apigee.)

Por exemplo, pode usar o Terraform para configurar:

Para informações sobre a funcionalidade atualmente suportada, consulte a secção Apigee do Registo do Terraform. Os nomes de recursos relacionados com a segurança avançada da API começam com google_apigee_security.

Passos seguintes

Depois de ativar a segurança avançada da API, consulte: