API Security Actions

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

Veja a documentação do Apigee Edge.

Esta página descreve como gerir ações de segurança através das APIs Apigee Management. Para ver uma vista geral da funcionalidade de ações de segurança, incluindo limitações e latências, consulte o artigo Vista geral e IU das ações de segurança.

Pode aceder a todas as funcionalidades de ações de segurança através das APIs de gestão da Apigee. Consulte a referência da API Security Actions para ver informações sobre todos os comandos disponíveis. Esta página mostra exemplos de alguns dos comandos disponíveis.

Variáveis usadas nos exemplos

Os exemplos nesta página podem incluir estas variáveis:

  • ORG é a organização.
  • ENV é o ambiente para a ação de segurança.
  • ACTION_NAME é o nome da ação de segurança.

Crie ações de segurança

Esta secção apresenta exemplos de como criar ações de segurança com diferentes tipos de ações.

Crie uma ação de recusa

Para criar uma ação de recusa, introduza um comando semelhante ao seguinte:

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.225.0"]}}'

Esta ação de segurança nega o acesso a pedidos aos endereços IP indicados após ip_address_ranges e devolve um código de resposta 404.

Crie uma ação de sinalização

Para criar uma ação de denúncia, introduza um comando semelhante ao seguinte:

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "flag": {"headers": [{"name": "senseflag", "value": "flagvalue"}]}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}'

Isto cria uma ação de segurança que marca os pedidos dos endereços IP indicados após ip_address_ranges e adiciona um cabeçalho senseflag com o valor flagvalue.

Crie uma ação de permissão

Para criar uma ação de permissão, introduza um comando semelhante ao seguinte:

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "allow": {}, "condition_config": {"ip_address_ranges": ["100.0.220.0", "200.0.0.0"]}}'

Isto cria uma ação de segurança que permite pedidos dos endereços IP indicados após ip_address_ranges.

Edite ações de segurança

Esta secção fornece um exemplo de como editar uma configuração de ação de segurança existente. Consulte Ativar ou desativar uma ação de segurança ou Eliminar uma ação de segurança para ver exemplos desses tipos de alterações.

Edite uma ação de recusa

Esta secção mostra um exemplo de edição de uma ação de recusa. As APIs também suportam a edição dos outros tipos de ações.

update_mask pode incluir qualquer uma destas opções: description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,* (tudo) ou omitido (predefinição para tudo).

Consulte a documentação de referência da API Security Actions para mais informações sobre os valores potenciais ao editar ações.

  curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME?update_mask=deny,condition_config" \
         -H "Authorization: Bearer $TOKEN" \
         -d '{"deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}' \
         -H "Content-Type: application/json"
         {
           "name": "ACTION_NAME",
           "state": "ENABLED",
           "createTime": "2022-12-29T18:28:50Z",
           "updateTime": "2022-12-29T18:28:50Z",
           "conditionConfig": {
             "ipAddressRanges": [
               "100.0.230.0"
             ]
           },
           "deny": {
             "responseCode": 404
           }
         }

Ative ou desative uma ação de segurança

Os exemplos seguintes mostram chamadas de API para ativar ou desativar ações de segurança.

Ative uma ação de segurança

Para ativar uma ação de segurança, introduza um comando semelhante ao seguinte:

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"
       -H "Authorization: Bearer $TOKEN"

Isto devolve uma resposta semelhante à seguinte:

{
      "name": "ACTION_NAME",
      "state": "ENABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:19:26.650965481Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
}

Desative uma ação de segurança

Para desativar uma ação de segurança, introduza um comando semelhante ao seguinte:

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"
       -H "Authorization: Bearer $TOKEN"

Isto devolve uma resposta semelhante à seguinte:

{
      "name": "actionallow",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04.874540001Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
}

Obtenha ou liste ações de segurança

Os exemplos seguintes mostram como obter ou listar ações de segurança

Obtenha uma ação de segurança

Para obter uma ação de segurança, introduza um comando semelhante ao seguinte:

curl -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"
       -H "Authorization: Bearer $TOKEN"

Isto devolve uma resposta semelhante à seguinte:

{
      "name": "ACTION_NAME",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
}

Indicar ações de segurança

Para apresentar uma lista de todas as ações de segurança, introduza um comando semelhante ao seguinte:

curl -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"
       -H "Authorization: Bearer $TOKEN"

Pause ou retome ações de segurança

Os exemplos seguintes mostram como pausar ou retomar ações de segurança

Pause todas as ações de segurança

Para pausar todas as ações de segurança, introduza um comando semelhante ao seguinte:

curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"enabled": "false", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

Isto devolve uma resposta semelhante à seguinte:

{
      "name": "organizations/ORG/environments/ENV/securityActionsConfig",
      "enabled": false,
      "updateTime": "2023-01-23T21:44:58.063807Z"
}

Retome as ações de segurança pausadas

Para retomar as ações de segurança pausadas, introduza um comando semelhante ao seguinte:

curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"enabled": "true", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

Isto devolve uma resposta semelhante à seguinte:

{
      "name": "organizations/ORG/environments/ENV/securityActionsConfig",
      "enabled": true,
      "updateTime": "2023-01-23T21:44:58.063807Z"
}

Elimine ações de segurança

Para eliminar uma ação de segurança, introduza um comando semelhante ao seguinte:

curl -X DELETE "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"
       -H "Authorization: Bearer $TOKEN"