Primeros pasos

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

Consulta la documentación de Apigee Edge.

En esta página se explica cómo empezar a usar la seguridad avanzada de las APIs para organizaciones con suscripción y de pago por uso.

Roles y permisos necesarios

En las siguientes secciones se describen los roles y permisos necesarios para realizar tareas con la seguridad avanzada de las APIs.

Roles necesarios para los informes de seguridad

En la tabla siguiente se muestran los roles necesarios para realizar tareas relacionadas con los informes de seguridad.

Tarea de informe de seguridad Rol(es) obligatorio(s)
Habilitar o inhabilitar la seguridad avanzada de las APIs Administrador de organización de Apigee (roles/apigee.admin)
Crear informes Administrador de organización de Apigee (roles/apigee.admin)
Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Ver informes Apigee Security Viewer (roles/apigee.securityViewer)
Apigee Security Admin (roles/apigee.securityAdmin)

Roles necesarios para la evaluación de riesgos

En la tabla siguiente se muestran los roles necesarios para realizar tareas relacionadas con la evaluación de riesgos.

Tarea de evaluación de riesgos Rol(es) obligatorio(s)
Crear, actualizar o eliminar un perfil de seguridad personalizado Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Administrador de organización de Apigee (roles/apigee.admin)
Adjuntar o separar un perfil de seguridad Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Administrador de la organización de Apigee (roles/apigee.admin)
Ver las puntuaciones de seguridad Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Lector de seguridad de Apigee (roles/apigee.securityViewer)
Administrador de la organización de Apigee (roles/apigee.admin)
Mostrar todos los perfiles de seguridad u obtener uno Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Lector de seguridad de Apigee (roles/apigee.securityViewer)
Administrador de la organización de Apigee (roles/apigee.admin)
Crear, actualizar o eliminar una condición de monitorización de seguridad Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Administrador de organización de Apigee (roles/apigee.admin)
Mostrar y ver las condiciones de monitorización de seguridad Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Lector de seguridad de Apigee (roles/apigee.securityViewer)
Administrador de la organización de Apigee (roles/apigee.admin)
Mostrar y ver métricas de condiciones de monitorización de seguridad Administrador de monitorización (roles/monitoring.admin)
Editor de monitorización (roles/monitoring.editor)
Crear, actualizar o eliminar alertas de monitorización Consulta Roles necesarios (para alertas de seguridad).
Ver alertas de monitorización Consulta Incidentes de políticas de alertas basadas en métricas: antes de empezar.

Roles y permisos necesarios para la detección de abusos

En la tabla siguiente se muestran los roles y permisos necesarios para realizar tareas relacionadas con la detección de abusos.

Tarea de detección de abusos Roles y permisos necesarios
Ver incidentes en la interfaz de detección de abusos Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Lector de seguridad de Apigee (roles/apigee.securityViewer)
Administrador de la organización de Apigee (roles/apigee.admin)
Ver las estadísticas de IA generativa de una incidencia Permiso de cloudaicompanion.instances.generateText
Habilitar o inhabilitar modelos de aprendizaje automático para la detección de abusos en una organización Permiso apigee.securitySettings.update
Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Administrador de la organización de Apigee (roles/apigee.admin)

Roles necesarios para las acciones de seguridad

En la tabla siguiente se muestran los roles necesarios para realizar tareas relacionadas con las acciones de seguridad.

Tarea de acción de seguridad Rol(es) obligatorio(s)
Crear, editar o eliminar configuraciones de acciones de seguridad Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Administrador de la organización de Apigee (roles/apigee.admin)
Ver o enumerar acciones de seguridad Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Lector de seguridad de Apigee (roles/apigee.securityViewer)
Administrador de la organización de Apigee (roles/apigee.admin)
Comprobar el estado de la medida Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Lector de seguridad de Apigee (roles/apigee.securityViewer)
Administrador de la organización de Apigee (roles/apigee.admin)

Gestionar la seguridad avanzada de las APIs de organizaciones de suscripción

Para usar Seguridad Avanzada de APIs como cliente de Suscripción, Seguridad Avanzada de APIs debe formar parte de tus derechos de Suscripción. Consulta los derechos de Apigee. Para añadir Seguridad avanzada de las APIs a tus derechos, ponte en contacto con el equipo de Ventas de Apigee.

Una vez que la seguridad avanzada de las APIs forme parte de tus derechos, habilítala en tu organización:

Si no sabes con seguridad si estás usando una organización de Apigee con suscripción o con pago por uso, ponte en contacto con el administrador de tu organización de Apigee.

Obtener la configuración de tus complementos de Apigee

Para habilitar la seguridad avanzada de las APIs en tu organización de suscripciones, primero debes obtener la configuración actual de los complementos de Apigee mediante la siguiente llamada a la API. También te indicará si Advanced API Security ya está habilitada.

curl "https://apigee.googleapis.com/v1/organizations/ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

donde

Esta llamada devuelve información básica sobre tu organización, incluida una sección para la configuración de tus complementos de Apigee que empieza con la línea:

"addonsConfig": {

Comprueba si esta sección contiene la siguiente entrada:

"apiSecurityConfig": {
          "enabled": true
      }

Si es así, la seguridad avanzada de las APIs ya está habilitada en la organización. De lo contrario, debes habilitarlo, tal como se describe a continuación.

Habilitar la seguridad avanzada de las APIs en organizaciones de suscripciones

Para habilitar la seguridad avanzada de las APIs en una organización de suscripción con la configuración predeterminada, envía una solicitud POST como la que se muestra a continuación.

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

donde

Por ejemplo, si la configuración actual de los complementos es

"addonsConfig": {
  "integrationConfig": {
      "enabled":true
  },
  "monetizationConfig": {
      "enabled":true
  }
},

El comando para habilitar la seguridad avanzada de las APIs sería

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

Después de enviar la solicitud, verás una respuesta como la siguiente:

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

Inhabilitar la seguridad avanzada de las APIs en organizaciones de suscripción

Si por algún motivo necesitas inhabilitar la seguridad avanzada de las APIs en tu organización de suscripciones, puedes hacerlo enviando una solicitud POST y transfiriendo la configuración de los complementos en el cuerpo de la solicitud, tal como se muestra a continuación.

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

A continuación se muestra un ejemplo de la respuesta que indica que la operación está en 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 obtener más información, consulta la API Configure organization add-ons.

Gestionar la seguridad avanzada de las APIs en organizaciones con pago por uso

Si eres cliente del plan Pay-as-you-go, puedes habilitar Advanced API Security como complemento de pago. Para obtener más información sobre cómo habilitar el complemento Advanced API Security en tus entornos Intermedio o Completo de Apigee, consulta el artículo Gestionar el complemento Advanced API Security.

Si no sabes con seguridad si estás usando una organización de Apigee con suscripción o con pago por uso, ponte en contacto con el administrador de tu organización de Apigee.

Gestionar la seguridad avanzada de las APIs en organizaciones de evaluación

El complemento Advanced API Security se incluye automáticamente en las organizaciones de prueba (evaluación) de Apigee, pero tendrás que habilitarlo.

Para habilitarla, sigue las instrucciones que se indican en Habilitar la seguridad avanzada de las APIs en organizaciones de suscripción.

Si necesitas inhabilitarla, sigue las instrucciones que se indican en Inhabilitar la seguridad avanzada de las APIs en organizaciones con suscripción.

Configurar la seguridad avanzada de la API con Terraform

Apigee admite el uso de Terraform para gestionar algunas funciones de Advanced API Security.

Por ejemplo, puedes usar Terraform para configurar lo siguiente:

Para obtener información sobre las funciones admitidas actualmente, consulta la sección Apigee del registro de Terraform. Los nombres de recursos relacionados con la seguridad avanzada de las APIs empiezan por google_apigee_security.

Pasos siguientes

Una vez que hayas habilitado la seguridad avanzada de las APIs, consulta lo siguiente: