Se usó la API de Cloud Translation para traducir esta página.

API de acciones de seguridad

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

En esta página, se describe cómo administrar las acciones de seguridad con las APIs de Apigee Management. Para obtener una descripción general de la funcionalidad de las acciones de seguridad, incluidas las limitaciones y las latencias, consulta Descripción general de las acciones de seguridad y la IU.

Puedes acceder a todas las funciones de acciones de seguridad a través de las APIs de administración de Apigee. Consulta la referencia de la API de Security Actions para obtener información sobre todos los comandos disponibles. En esta página, se muestran ejemplos de algunos de los comandos disponibles.

Variables que se usan en los ejemplos

Los ejemplos de esta página pueden incluir las siguientes variables:

ORG es la organización.
ENV es el entorno de la acción de seguridad.
ACTION_NAME es el nombre de la acción de seguridad.

Crea acciones de seguridad

En esta sección, se proporcionan ejemplos para crear acciones de seguridad con diferentes tipos de acciones.

Crea una acción de denegación

Para crear una acción de denegación, ingresa un comando similar al siguiente:

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

Esto crea una acción de seguridad que rechaza el acceso a las solicitudes a las direcciones IP enumeradas después de ip_address_ranges y muestra un código de respuesta 404.

Crea una acción de marca

Para crear una acción de marca, ingresa un comando similar al siguiente:

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

Esto crea una acción de seguridad que marca las solicitudes de las direcciones IP que se enumeran después de ip_address_ranges y agrega un encabezado senseflag con el valor flagvalue.

Crea una acción de permiso

Para crear una acción de permiso, ingresa un comando similar al siguiente:

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

Esto crea una acción de seguridad que permite solicitudes de las direcciones IP enumeradas después de ip_address_ranges.

Edita acciones de seguridad

En esta sección, se proporciona un ejemplo de cómo editar la configuración de una acción de seguridad existente. Consulta Habilita o inhabilita una acción de seguridad o Borra una acción de seguridad para ver ejemplos de esos tipos de cambios.

Cómo editar una acción de denegación

En esta sección, se muestra un ejemplo para editar una acción de rechazo. Las APIs también admiten la edición de los otros tipos de acciones.

update_mask puede incluir cualquiera de estas opciones: description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,* (todo) o se puede omitir (el valor predeterminado es todo).

Consulta la documentación de referencia de la API de Security Actions para obtener más información sobre los valores posibles cuando edites acciones.

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

Habilita o inhabilita una acción de seguridad

En los siguientes ejemplos, se muestran llamadas a la API para habilitar o inhabilitar acciones de seguridad.

Habilita una acción de seguridad

Para habilitar una acción de seguridad, ingresa un comando similar al siguiente:

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

Esto devuelve una respuesta como la que se muestra a continuación:

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

Inhabilita una acción de seguridad

Para inhabilitar una acción de seguridad, ingresa un comando similar al siguiente:

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

Esto devuelve una respuesta como la que se muestra a continuación:

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

Obtén o enumera las acciones de seguridad

En los siguientes ejemplos, se muestra cómo obtener o enumerar acciones de seguridad

Obtener una acción de seguridad

Para obtener una acción de seguridad, ingresa un comando similar al siguiente:

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

Esto devuelve una respuesta como la que se muestra a continuación:

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

Enumera acciones de seguridad

Para enumerar todas las acciones de seguridad, ingresa un comando similar al siguiente:

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

Pausa o reanuda acciones de seguridad

En los siguientes ejemplos, se muestra cómo pausar o reanudar acciones de seguridad

Detén todas las acciones de seguridad

Para pausar todas las acciones de seguridad, ingresa un comando similar al siguiente:

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

Esto devuelve una respuesta como la que se muestra a continuación:

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

Reanudar las acciones de seguridad en pausa

Para reanudar las acciones de seguridad pausadas, ingresa un comando similar al siguiente:

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

Esto devuelve una respuesta como la que se muestra a continuación:

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

Borra acciones de seguridad

Para borrar una acción de seguridad, ingresa un comando similar al siguiente:

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