API de acciones de seguridad

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

Consulta la documentación de Apigee Edge.

Además de usar Acciones de seguridad en la IU de Apigee, también puedes acceder a todas las funciones de Acciones de seguridad a través de la API de Apigee.

Limitaciones de las acciones de seguridad

Las acciones de seguridad se aplican a nivel de entorno de Apigee. Para cada entorno, las acciones de seguridad tienen las siguientes limitaciones:

  • Se permite un máximo de 1,000 acciones habilitadas para un entorno en cualquier momento.
  • Puedes agregar como máximo 5 encabezados de marca para cada acción.

Latencias

Las acciones de seguridad tienen las siguientes latencias:

  • Cuando creas una acción de seguridad, la acción puede tardar hasta 10 minutos en aplicarse. Una vez que se aplique una acción y se aplique a algo de tráfico de la API, podrás ver los efectos de la acción en la página Detalles de la acción de seguridad. Nota: Incluso si la acción entró en vigencia, no podrás determinarlo en la página de detalles de la acción de seguridad, a menos que la acción se haya aplicado a un tráfico de API.
  • Las acciones de seguridad habilitadas generan un pequeño aumento (menos del 2%) en el tiempo de respuesta del proxy de API.

Crea acciones de seguridad

En los siguientes ejemplos, se muestra cómo crear acciones de seguridad con llamadas a la API. En todos los ejemplos:

  • 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 una acción de denegación

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

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
        -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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
        -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.

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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"

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

{
      "name": "ACTION_ALLOW",
      "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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"

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 -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"

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 -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"

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 -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -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//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  -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -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"
    }
}