Premiers pas

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Cette page explique comment utiliser Advanced API Security.

Rôles requis

Les sections suivantes décrivent les rôles requis pour effectuer des tâches à l'aide de la fonctionnalité Advanced API Security.

Rôles requis pour les rapports de sécurité

Le tableau ci-dessous présente les rôles requis pour effectuer des tâches liées aux rapports de sécurité.

Tâche liée aux rapports de sécurité	Rôles requis
Activer ou désactiver Advanced API Security	Administrateur de l'organisation Apigee (roles/apigee.admin)
Créer et afficher des rapports	Administrateur de l'organisation Apigee (roles/apigee.admin) Administrateur de sécurité Apigee (roles/apigee.securityAdmin)
Afficher les rapports	Lecteur de sécurité Apigee (roles/apigee.securityViewer) Administrateur de sécurité Apigee (roles/apigee.securityAdmin)

Rôles requis pour l'évaluation des risques

Le tableau ci-dessous présente les rôles requis pour effectuer des tâches liées à l'évaluation des risques.

Tâche d'évaluation des risques	Rôles requis
Créer, mettre à jour ou supprimer un profil de sécurité personnalisé	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Administrateur de l'organisation Apigee (roles/apigee.admin)
Associer ou dissocier un profil de sécurité	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Administrateur de l'organisation Apigee (roles/apigee.admin)
Afficher les scores de sécurité	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Lecteur de sécurité Apigee (roles/apigee.securityViewer) Administrateur de l'organisation Apigee (roles/apigee.admin)
Répertorier tous les profils de sécurité ou obtenir un profil	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Lecteur de sécurité Apigee (roles/apigee.securityViewer) Administrateur de l'organisation Apigee (roles/apigee.admin)

Rôles requis pour la détection des abus

Le tableau ci-dessous présente les rôles requis pour effectuer des tâches liées à la détection des abus.

Tâche liée à la détection des abus	Rôles requis
Afficher les incidents dans l'interface utilisateur de détection des abus	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Lecteur de sécurité Apigee (roles/apigee.securityViewer) Administrateur de l'organisation Apigee (roles/apigee.admin)

Rôles requis pour les actions de sécurité

Le tableau ci-dessous présente les rôles requis pour effectuer des tâches liées aux actions de sécurité.

Tâche d'action de sécurité	Rôles requis
Créer des actions de sécurité	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Administrateur de l'organisation Apigee (roles/apigee.admin)
Mettre à jour la configuration des actions de sécurité	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Administrateur de l'organisation Apigee (roles/apigee.admin)
Afficher ou répertorier les actions de sécurité	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Lecteur de sécurité Apigee (roles/apigee.securityViewer) Administrateur de l'organisation Apigee (roles/apigee.admin)
Vérifier l'état de l'application	Administrateur de sécurité Apigee (roles/apigee.securityAdmin) Lecteur de sécurité Apigee (roles/apigee.securityViewer) Administrateur de l'organisation Apigee (roles/apigee.admin)

Remarque : Pour effectuer les appels d'API décrits dans les sections suivantes, vous devez obtenir un jeton d'accès OAuth 2.0, qui est transmis avec les appels.

Gérer Advanced API Security pour les organisations avec abonnement

Pour utiliser Advanced API Security en tant que client abonné, vous devez l'activer dans votre organisation, comme décrit dans les sections suivantes :

• Obtenir la configuration de vos modules complémentaires Apigee
• Activer Advanced API Security pour les organisations avec abonnement

Si vous ne savez pas si vous utilisez une organisation Apigee avec abonnement ou en paiement à l'usage, contactez l'administrateur de votre organisation Apigee.

Obtenir la configuration de vos modules complémentaires Apigee

Pour activer Advanced API Security pour votre organisation avec abonnement, vous devez d'abord obtenir la configuration de vos modules complémentaires Apigee actuelle à l'aide de l'appel d'API suivant. Cela vous indiquera également si Advanced API Security est déjà activé.

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

Où :

• ORG est le nom de votre organisation.
• $TOKEN est la variable d'environnement d'un jeton d'accès OAuth.

Cet appel renvoie des informations de base sur votre organisation, qui incluent une section concernant votre configuration de modules complémentaires Apigee commençant par la ligne suivante :

"addonsConfig": {

Vérifiez si cette section contient l'entrée suivante :

"apiSecurityConfig": {
          "enabled": true
      }

Si c'est le cas, Advanced API Security est déjà activé dans l'organisation. Sinon, vous devez l'activer, comme décrit ci-dessous.

Activer Advanced API Security pour les organisations avec abonnement

Pour activer Advanced API Security dans l'organisation avec abonnement selon la configuration par défaut, envoyez une requête POST comme celle présentée ci-dessous :

Attention : Cet appel d'API écrase la configuration actuelle des modules complémentaires. Vous devez inclure la configuration actuelle de tous les modules complémentaires dans la requête présentée ci-dessous pour éviter qu'ils ne soient écrasés.

Remarques :

• Si vous créez un environnement après avoir activé Advanced API Security, vous devez exécuter à nouveau la commande ci-dessous pour activer Advanced API Security dans le nouvel environnement. Notez qu'il n'est pas nécessaire de désactiver Advanced API Security avant d'exécuter à nouveau la commande.
• Si vous dissociez simplement un environnement dans lequel Advanced API Security est activé à partir d'une instance, puis que vous le réassociez ultérieurement, vous n'avez pas besoin d'exécuter à nouveau la commande ci-dessous.

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

Où :

• ORG est le nom de votre organisation.
• $TOKEN est la variable d'environnement d'un jeton d'accès OAuth.
• <Other entries of your current add-ons configuration> se compose de n'importe quelle autre entrée de la configuration des modules complémentaires Apigee actuelle.

Remarque : L'appel d'API ci-dessus démarre une opération de longue durée qui peut prendre un certain temps.

Par exemple, si la configuration actuelle des modules complémentaires est :

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

la commande permettant d'activer Advanced API Security est

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

Une fois la requête envoyée, une réponse semblable à celle-ci s'affiche :

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

Remarque : Lorsque vous activez Advanced API Security dans une organisation, l'actualisation des scores des proxys et des cibles existants dans un environnement peut prendre jusqu'à une journée.

Désactiver Advanced API Security pour les organisations avec abonnement

Si, pour une raison quelconque, vous devez désactiver Advanced API Security dans votre organisation avec abonnement, vous pouvez envoyer une requête POST en transmettant la configuration des modules complémentaires dans le corps de votre requête, comme indiqué ci-dessous.

Attention : La configuration des modules complémentaires que vous transmettez dans le corps de la requête écrase la configuration actuelle des modules complémentaires. Affichez la configuration du module complémentaire existant dans le profil d'organisation Apigee et veillez à l'inclure dans la charge utile de la requête.

Remarque : L'appel d'API ci-dessous démarre une opération de longue durée qui peut prendre un certain temps.

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

Voici un exemple de réponse indiquant que l'opération est en cours :

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

Pour en savoir plus, consultez la page Configurer l'API de modules complémentaires de l'organisation.

Gérer Advanced API Security pour les organisations avec paiement à l'usage

Si vous êtes un client avec Pay-as-you-go, vous pouvez activer Advanced API Security en tant que module complémentaire payant. Pour en savoir plus sur l'activation du module complémentaire Advanced API Security pour vos environnements Apigee intermédiaires ou complets, consultez la page Gérer le module complémentaire Advanced API Security.

Si vous ne savez pas si vous utilisez une organisation Apigee avec abonnement ou en paiement à l'usage, contactez l'administrateur de votre organisation Apigee.

Étapes suivantes

Une fois que vous avez activé Advanced API Security, consultez les sections suivantes :

• Rapports relatifs à la sécurité
• Évaluation des risques
• Détection des abus
• Actions de sécurité