Gérer le module complémentaire Advanced API Security

Cette page s'applique à Apigee, mais pas à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Advanced API Security surveille en permanence vos API pour les protéger contre les menaces de sécurité, y compris les attaques de clients malveillants et les utilisations abusives. Advanced API Security analyse votre trafic d'API pour identifier les requêtes suspectes et fournit des outils qui peuvent bloquer ou signaler ces requêtes. En outre, Advanced API Security évalue vos configurations d'API pour s'assurer qu'elles répondent aux normes de sécurité et vous donne des recommandations pour les améliorer si nécessaire.

Si vous êtes un client Apigee facturé à l'usage, Advanced API Security est disponible en tant que module complémentaire payant. Cette rubrique explique comment activer et gérer le module complémentaire Advanced API Security pour les environnements avec paiement à l'usage éligibles. Pour en savoir plus sur l'utilisation d'Advanced API Security après l'activation du module complémentaire dans vos environnements Apigee, consultez la page Présentation de Advanced API Security.

Qui peut en bénéficier ?

Advanced API Security est disponible en tant que module complémentaire payant géré individuellement pour chaque environnement Apigee dans votre mise en œuvre Apigee. Le module complémentaire peut être activé dans n'importe quel environnement Apigee intermédiaire ou complet. Vous ne pouvez pas activer ni utiliser Advanced API Security dans les environnements de base. Pour en savoir plus sur les capacités de l'environnement Apigee, consultez la page Comparaison des types d'environnement.

Remarque : Avant d'activer le module complémentaire Advanced API Security dans un environnement, assurez-vous que le module complémentaire Apigee API Analytics est activé pour l'environnement. Si Apigee API Analytics n'est pas activé, toute requête permettant d'activer Advanced API Security dans l'environnement échouera.

Si le module complémentaire Apigee API Analytics est activé dans votre environnement, il s'affiche dans la colonne Autres modules complémentaires activés du panneau module complémentaire Advanced API Security. Pour activer le module complémentaire, consultez la page Activer le module complémentaire Apigee API Analytics.

Rôles et autorisations requis

Pour obtenir les autorisations nécessaires pour gérer le module complémentaire Advanced API Security, demandez à votre administrateur de vous accorder le rôle IAM "Administrateur d'environnement Apigee" (apigee.environment.admin) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Ce rôle prédéfini contient les autorisations requises pour gérer le module complémentaire Advanced API Security. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour gérer le module complémentaire Advanced API Security :

• apigee.addonsconfig.get
• apigee.addonsconfig.update

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Une fois le module complémentaire activé, des rôles supplémentaires peuvent être requis pour effectuer des tâches à l'aide de Advanced API Security. Pour en savoir plus, consultez la section Rôles requis.

Activer le module complémentaire Advanced API Security

Vous pouvez activer le module complémentaire Advanced API Security pour un environnement Apigee Intermédiaire ou Complet à l'aide de l'interface utilisateur Apigee dans la console Google Cloud ou de l'API, comme décrit dans les sections suivantes.

Remarque : Le module complémentaire Advanced API Security ne peut pas être activé dans un environnement de base.

Apigee dans la console Google Cloud

Pour activer le module complémentaire Advanced API Security dans la console Google Cloud, procédez comme suit :

1. Ouvrez la page Apigee dans la console.

   Accéder à Apigee

2. Sélectionnez le projet contenant l'organisation avec paiement à l'usage et les environnements que vous souhaitez gérer.
3. Sélectionnez Modules complémentaires > Advanced API Security pour ouvrir la page du module complémentaire Advanced API Security.
4. Dans le volet Gérer le module complémentaire Advanced API Security, cochez la case correspondant à l'environnement (ou aux environnements) dans lequel vous souhaitez activer le module complémentaire.
5. Cliquez sur Activer la sélection.
6. Une fois l'activation terminée pour les environnements sélectionnés, l'état de l'environnement s'affiche comme Activé.
7. Sélectionnez Advanced API Security pour afficher les options de page permettant d'utiliser vos données de sécurité, y compris l'Évaluation des risques, la Détection d'utilisation abusive, les Rapports relatifs à la sécurité et les Actions de sécurité. L'affichage des données de Advanced API Security peut prendre jusqu'à 10 minutes.

API Apigee

Pour activer le module complémentaire Advanced API Security à l'aide de l'API Apigee, saisissez la commande suivante :

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"api_security_enabled":true}'

Où :

• ORG_NAME est le nom de l'organisation Apigee facturée à l'usage où vous souhaitez ajouter Advanced API Security aux environnements éligibles.
• ENV_NAME correspond au nom de l'environnement Apigee dans lequel vous souhaitez activer le module complémentaire Advanced API Security.

Une fois l'activation terminée, cliquez sur Advanced API Security pour afficher les options de page permettant d'utiliser vos données de sécurité, y compris l'évaluation des risques, la détection d'utilisation abusive, les rapports de sécurité et les actions de sécurité. L'affichage des données de Advanced API Security dans l'interface utilisateur peut prendre jusqu'à 10 minutes ou être disponible via un appel d'API.

Le processus d'activation du module complémentaire Advanced API Security peut prendre jusqu'à 15 minutes. Après l'activation, les données de sécurité de l'environnement sont conservées pendant 14 mois. Vous pouvez accéder aux données de l'historique de l'environnement sur les pages Advanced API Security de la console, à condition que le module complémentaire soit activé.

La facturation de l'utilisation du module complémentaire Advanced API Security commence dès l'activation du module complémentaire.

Désactiver le module complémentaire Advanced API Security

Vous pouvez désactiver le module complémentaire Advanced API Security pour un environnement intermédiaire ou complet à l'aide de l'interface utilisateur d'Apigee dans la console Google Cloud ou de l'API, comme décrit dans les sections suivantes.

Remarque : Si vous désactivez le module complémentaire Advanced API Security dans un environnement, les données de sécurité sont supprimées au bout de 30 jours. Pour en savoir plus, consultez la page Gérer les données de Advanced API Security.

Apigee dans la console Cloud

Pour désactiver le module complémentaire Advanced API Security dans la console Google Cloud, procédez comme suit :

1. Ouvrez la page Apigee dans la console.

   Accéder à Apigee

2. Sélectionnez le projet contenant l'organisation avec paiement à l'usage et les environnements que vous souhaitez gérer.
3. Sélectionner Modules complémentaires > Advanced API Security pour ouvrir la page du module complémentaire Advanced API Security.
4. Dans le volet Gérer le module complémentaire Advanced API Security, cochez la case correspondant à l'environnement (ou aux environnements) dans lequel vous souhaitez désactiver le module complémentaire.
5. Cliquez sur Désactiver la sélection.
6. Après la désactivation, l'état s'affiche comme Désactivé pour chaque environnement.

API Apigee

Pour désactiver le module complémentaire Advanced API Security à l'aide de l'API Apigee, saisissez la commande suivante :

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"api_security_enabled":false}'

Où :

• ORG_NAME est le nom de l'organisation Apigee facturée à l'usage où vous souhaitez désactiver Advanced API Security dans les environnements éligibles.
• ENV_NAME est le nom de l'environnement Apigee dans lequel vous souhaitez désactiver le module complémentaire Advanced API Security.

Afficher l'état du module complémentaire Advanced API Security dans un environnement

Vous pouvez vérifier l'état du module complémentaire Advanced API Security pour un environnement Apigee intermédiaire ou complet en utilisant l'interface utilisateur Apigee dans la console Google Cloud ou en utilisant l'API, comme décrit dans les sections suivantes.

Apigee dans la console Google Cloud

Pour afficher l'état du module complémentaire Advanced API Security dans un environnement à l'aide de la console Google Cloud, procédez comme suit :

1. Ouvrez la page Apigee dans la console.

   Accéder à Apigee

2. Sélectionnez le projet contenant l'organisation avec paiement à l'usage et les environnements que vous souhaitez gérer.
3. Sélectionnez Modules complémentaires > Advanced API Security pour ouvrir la page du module complémentaire Advanced API Security.
4. Dans le volet Gérer le module complémentaire Advanced API Security, une liste d'environnements s'affiche.
5. Dans la colonne d'état, vous pouvez voir si le module complémentaire est Activé ou Désactivé pour chaque environnement intermédiaire ou complet. Les environnements de base n'affichent aucun des deux états.

API Apigee

Pour afficher l'état du module complémentaire Advanced API Security dans un environnement en utilisant l'API Apigee, saisissez la commande suivante :

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" 

Où :

• ORG_NAME est le nom de l'organisation Apigee avec paiement à l'usage.
• ENV_NAME est le nom de l'environnement Apigee.

La réponse renvoie un objet ApiSecurityConfig représentant l'état actuel du module complémentaire.

Gérer les données Advanced API Security

Une fois que le module complémentaire Advanced API Security est activé pour un environnement, les données de sécurité de cet environnement sont conservées pendant 14 mois. Vous pouvez accéder aux rapports de sécurité précédemment générés pour l'environnement à partir de la page Rapports de sécurité dans la console, mais vous ne pouvez pas créer de rapports.

Si vous désactivez le module complémentaire Advanced API Security dans un environnement, les données de sécurité de l'environnement sont supprimées au bout de 30 jours. Si vous réactivez le module complémentaire dans le même environnement dans les 30 jours suivant sa désactivation, vous pouvez de nouveau accéder aux données de sécurité de l'environnement pendant la période de conservation de 14 mois. Aucune donnée n'est restaurée si le module complémentaire est réactivé pour l'environnement après 30 jours.

Si vous souhaitez conserver les rapports de sécurité pour un environnement au-delà de la période de conservation de 14 mois, nous vous recommandons d'exporter et d'enregistrer vos données dans un autre emplacement. Vous pouvez également exporter vos données Advanced API Security avant de désactiver le module complémentaire, ou dans le délai de 30 jours suivant la désactivation. Vous pouvez exporter vos rapports de sécurité à l'aide du bouton Exporter sur la page Rapports de sécurité dans la console, ou télécharger un rapport à l'aide de l'API des rapports de sécurité.