API Security Actions

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 gestionar las acciones de seguridad mediante las APIs de gestión de Apigee. Para obtener una descripción general de la función de acciones de seguridad, incluidas las limitaciones y las latencias, consulta el artículo Descripción general e interfaz de usuario de las acciones de seguridad.

Puedes acceder a todas las funciones de acciones de seguridad a través de las APIs de gestión de Apigee. Consulta la referencia de la API 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 usadas en los ejemplos

Los ejemplos de esta página pueden incluir estas 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.

Crear acciones de seguridad

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

Crear una acción de denegación

Para crear una acción de denegación, introduce 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"]}}'

De esta forma, se crea una acción de seguridad que deniega el acceso a las solicitudes a las direcciones IP que se indican después de ip_address_ranges y devuelve un código de respuesta 404.

Crear una acción de marca

Para crear una acción de marca, introduce 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"]}}'

De esta forma, se crea una acción de seguridad que marca las solicitudes de las direcciones IP que se indican después de ip_address_ranges y añade un encabezado senseflag con el valor flagvalue.

Crear una acción de permitir

Para crear una acción de permitir, introduce 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"]}}'

De esta forma, se crea una acción de seguridad que permite las solicitudes de las direcciones IP que se indican después de ip_address_ranges.

Editar acciones de seguridad

En esta sección se muestra un ejemplo de cómo editar una configuración de acción de seguridad. Consulta Habilitar o inhabilitar una acción de seguridad o Eliminar una acción de seguridad para ver ejemplos de esos tipos de cambios.

Editar una acción de denegación

En esta sección se muestra un ejemplo de cómo editar una acción de denegación. Las APIs también permiten editar los demás tipos de acciones.

update_mask puede incluir cualquiera de estas opciones: description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,* (todo) u omitirse (en cuyo caso, se incluirá todo de forma predeterminada).

Consulta la documentación de referencia de la API Security Actions para obtener más información sobre los valores posibles al editar 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
           }
         }

Habilitar o inhabilitar una acción de seguridad

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

Habilitar una acción de seguridad

Para habilitar una acción de seguridad, introduce 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"

Se devuelve una respuesta como la siguiente:

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

Inhabilitar una acción de seguridad

Para inhabilitar una acción de seguridad, introduce 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"

Se devuelve una respuesta como la siguiente:

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

Obtener o enumerar 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, introduce un comando similar al siguiente:

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

Se devuelve una respuesta como la siguiente:

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

Mostrar acciones de seguridad

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

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

Pausar o reanudar acciones de seguridad

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

Pausar todas las acciones de seguridad

Para pausar todas las acciones de seguridad, introduce 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"}'

Se devuelve una respuesta como la siguiente:

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

Reanudar acciones de seguridad pausadas

Para reanudar las acciones de seguridad pausadas, introduce 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"}'

Se devuelve una respuesta como la siguiente:

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

Eliminar acciones de seguridad

Para eliminar una acción de seguridad, introduce un comando similar al siguiente:

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