Primeros pasos

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

Consulta la documentación de Apigee Edge.

En esta sección, se explica cómo comenzar a usar Advanced API Security.

Roles obligatorios

En las siguientes tablas, se describen los roles necesarios para realizar tareas con la seguridad avanzada de la API.

Roles requeridos para los informes de seguridad

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

Tarea de informe de seguridad	Roles requeridos
Habilita o inhabilita Advanced API Security	Administrador de la organización de Apigee (roles/apigee.admin)
Crear y ver informes	Administrador de la organización de Apigee (roles/apigee.admin) Administrador de seguridad de Apigee (roles/apigee.securityAdmin)
Ver informes	Visualizador de seguridad de Apigee (roles/apigee.securityViewer) Administrador de seguridad de Apigee (roles/apigee.securityAdmin)

Roles necesarios para la evaluación de riesgos

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

Tarea de evaluación de riesgos	Roles requeridos
Crea, actualiza o borra un perfil de seguridad personalizado	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Administrador de la organización de Apigee (roles/apigee.admin)
Adjunta o desconecta un perfil de seguridad	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Administrador de la organización de Apigee (roles/apigee.admin)
Visualiza las puntuaciones de seguridad	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Visualizador de seguridad de Apigee (roles/apigee.securityViewer) Administrador de la organización de Apigee (roles/apigee.admin)
Obtener un perfil o enumera todos los perfiles de seguridad	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Visualizador de seguridad de Apigee (roles/apigee.securityViewer) Administrador de la organización de Apigee (roles/apigee.admin)

Roles requeridos para la detección de abusos

En la siguiente tabla, se muestran los roles necesarios para realizar tareas relacionadas con la detección de abuso.

Tarea de detección de abuso	Roles requeridos
Visualiza los incidentes en la IU de detección de abuso	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Visualizador de seguridad de Apigee (roles/apigee.securityViewer) Administrador de la organización de Apigee (roles/apigee.admin)

Roles requeridos para las acciones de seguridad

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

Tarea de acción de seguridad	Roles requeridos
Crea acciones de seguridad	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Administrador de la organización de Apigee (roles/apigee.admin)
Actualiza la configuración de las acciones de seguridad	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Administrador de la organización de Apigee (roles/apigee.admin)
Visualiza o enumera las acciones de seguridad	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Visualizador de seguridad de Apigee (roles/apigee.securityViewer) Administrador de la organización de Apigee (roles/apigee.admin)
Verifica el estado de aplicación	Administrador de seguridad de Apigee (roles/apigee.securityAdmin) Visualizador de seguridad de Apigee (roles/apigee.securityViewer) Administrador de la organización de Apigee (roles/apigee.admin)

Nota: Para realizar las llamadas a la API que se describen en las siguientes secciones, debes obtener un token de acceso de OAuth 2.0, que se pasa con las llamadas.

Administra Advanced API Security para las organizaciones de suscripción

Para usar Advanced API Security como cliente de suscripción, debes habilitarla en tu organización, como se describe en las siguientes secciones:

• Obtén la configuración de complementos de Apigee
• Habilita Advanced API Security para organizaciones de suscripción

Si no estás seguro de si usas una organización de suscripción de Apigee o de pago por uso, comunícate con el administrador de tu organización de Apigee.

Obtén la configuración de complementos de Apigee

Para habilitar Advanced API Security para tu organización de suscripción, primero debes obtener la configuración actual de los complementos de Apigee mediante la siguiente llamada a la API. Esto 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

• ORG es el nombre de tu organización.
• $TOKEN es la variable de entorno para un token de acceso de OAuth.

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

"addonsConfig": {

Comprueba si esta sección contiene la siguiente entrada:

"apiSecurityConfig": {
          "enabled": true
      }

Si es así, Advanced API Security ya está habilitada en la organización. De lo contrario, debes habilitarla, como se describe a continuación.

Habilita Advanced API Security para organizaciones de suscripción

Para habilitar Advanced API Security en la organización de suscripción con la configuración predeterminada, emite una solicitud POST como la que se muestra a continuación.

Precaución: Esta llamada a la API reemplaza la configuración actual de los complementos. Debes incluir la configuración actual para todos los complementos en la solicitud que se muestra a continuación a fin de evitar que se reemplacen.

Notas:

• Si creas un entorno nuevo después de habilitar Advanced API Security, debes ejecutar el comando a continuación para volver a habilitar Advanced API Security para el entorno nuevo. Ten en cuenta que no es necesario inhabilitar Advanced API Security antes de volver a ejecutar el comando.
• Si simplemente desconectas un entorno en el que Advanced API Security está habilitada desde una instancia y, luego, vuelves a adjuntarlo, no es necesario que vuelvas a ejecutar el comando 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

• ORG es el nombre de tu organización.
• $TOKEN es la variable de entorno para un token de acceso de OAuth.
• <Other entries of your current add-ons configuration> consiste en cualquier otra entrada de la configuración de complementos de Apigee actual.

Nota: La siguiente llamada a la API inicia una operación de larga duración que puede tardar un poco en completarse.

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

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

el comando para habilitar Advanced API Security 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"
  }
}

Nota: Cuando habilitas Advanced API Security en una organización, puede tardar hasta un día en que las puntuaciones de los proxies y destinos existentes se reflejen en un entorno.

Inhabilita Advanced API Security para organizaciones de suscripción

Si, por algún motivo, necesitas inhabilitar Advanced API Security en tu organización de suscripción, puedes hacerlo mediante la emisión de una solicitud POST y el paso de la configuración de complementos en el cuerpo de la solicitud, como se muestra a continuación.

Precaución: La configuración de los complementos que pases en el cuerpo de la solicitud reemplazará la configuración actual de los complementos. Visualiza la configuración actual de los complementos en el perfil de la organización de Apigee y asegúrate de incluirla en la carga útil de la solicitud.

Nota: La siguiente llamada a la API inicia una operación de larga duración que puede tardar un poco en completarse.

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 ofrece un ejemplo de la respuesta que muestra 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"
  }
}

Si deseas obtener más información, consulta Configura la API de complementos de la organización.

Administra Advanced API Security para las organizaciones de pago por uso

Si eres cliente de Pago por uso, puedes habilitar Advanced API Security como un complemento pagado. Si deseas obtener más información sobre cómo habilitar el complemento Advanced API Security para tus entornos de Apigee intermedios o integrales, consulta Administra el complemento Advanced API Security.

Si no estás seguro de si usas una organización de suscripción de Apigee o de pago por uso, comunícate con el administrador de tu organización de Apigee.

Próximos pasos

Una vez que hayas habilitado Advanced API Security, consulta las siguientes secciones:

• Informes de seguridad
• Evaluación de riesgos
• Detección de abusos
• Acciones de seguridad