Premiers pas

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

Consultez la documentation d' Apigee Edge.

Cette page explique comment commencer à utiliser Advanced API Security pour les organisations avec abonnement et paiement à l'usage.

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é.

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.

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.

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é.

Gérer Advanced API Security pour les organisations avec abonnement

Pour utiliser Advanced API Security en tant que client abonné, Advanced API Security doit faire partie de vos droits d'accès à l'abonnement. Consultez la page Droits pour Apigee. Pour ajouter Advanced API Security à vos droits d'accès, contactez le service commercial d'Apigee.

Une fois qu'Advanced API Security fait partie de vos droits d'accès, activez-la dans votre organisation:

• 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 :

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.

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

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.

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 paiement à l'usage, 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é