API des actions de sécurité

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

Consultez la documentation d'Apigee Edge.

Cette page explique comment gérer les actions de sécurité à l'aide des API de gestion Apigee. Pour obtenir une présentation du fonctionnement des actions de sécurité, y compris les limites et les latences, consultez Présentation et UI des actions de sécurité.

Vous pouvez accéder à toutes les fonctionnalités des actions de sécurité via les API de gestion Apigee. Pour en savoir plus sur toutes les commandes disponibles, consultez la documentation de référence de l'API d'actions de sécurité. Cette page fournit des exemples de certaines des commandes disponibles.

Variables utilisées dans les exemples

Les exemples présentés sur cette page peuvent inclure les variables suivantes :

  • ORG est l'organisation.
  • ENV est l'environnement de l'action de sécurité.
  • ACTION_NAME est le nom de l'action de sécurité.

Créer des actions de sécurité

Cette section fournit des exemples montrant comment créer des actions de sécurité avec différents types d'actions.

Créer une action de refus

Pour créer une action de refus, saisissez une commande semblable à celle-ci :

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.225.0"]}}'

Cela crée une action de sécurité qui refuse l'accès aux requêtes adressées aux adresses IP listées après ip_address_ranges et renvoie un code de réponse 404.

Créer une action de signalement

Pour créer une action de signalement, saisissez une commande semblable à celle-ci :

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "flag": {"headers": [{"name": "senseflag", "value": "flagvalue"}]}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}'

Cela crée une action de sécurité qui signale les requêtes provenant des adresses IP listées après ip_address_ranges et ajoute un en-tête senseflag dont la valeur est flagvalue.

Créer une action d'autorisation

Pour créer une action d'autorisation, saisissez une commande semblable à celle-ci :

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "allow": {}, "condition_config": {"ip_address_ranges": ["100.0.220.0", "200.0.0.0"]}}'

Cela crée une action de sécurité qui autorise les requêtes provenant des adresses IP listées après ip_address_ranges.

Modifier les actions de sécurité

Cette section fournit un exemple montrant comment modifier une configuration d'action de sécurité existante. Consultez Activer ou désactiver une action de sécurité ou Supprimer une action de sécurité pour voir des exemples de ces types de modifications.

Modifier une action de refus

Cette section présente un exemple de modification d'une action de refus. Les API permettent également de modifier les autres types d'actions.

update_mask peut inclure l'une des options suivantes : description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,* (tout) ou être omis (tout par défaut).

Pour en savoir plus sur les valeurs possibles lors de la modification des actions, consultez la documentation de référence de l'API d'actions de sécurité.

  curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME?update_mask=deny,condition_config" \
         -H "Authorization: Bearer $TOKEN" \
         -d '{"deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}' \
         -H "Content-Type: application/json"
         {
           "name": "ACTION_NAME",
           "state": "ENABLED",
           "createTime": "2022-12-29T18:28:50Z",
           "updateTime": "2022-12-29T18:28:50Z",
           "conditionConfig": {
             "ipAddressRanges": [
               "100.0.230.0"
             ]
           },
           "deny": {
             "responseCode": 404
           }
         }

Activer ou désactiver une action de sécurité

Les exemples suivants illustrent les appels d'API permettant d'activer ou de désactiver les actions de sécurité.

Activer une action de sécurité

Pour activer une action de sécurité, saisissez une commande semblable à la suivante :

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"
       -H "Authorization: Bearer $TOKEN"

La réponse renvoyée ressemble à celle-ci :

{
      "name": "ACTION_NAME",
      "state": "ENABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:19:26.650965481Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
}

Désactiver une action de sécurité

Pour désactiver une action de sécurité, saisissez une commande semblable à la suivante :

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"
       -H "Authorization: Bearer $TOKEN"

La réponse renvoyée ressemble à celle-ci :

{
      "name": "actionallow",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04.874540001Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
}

Obtenir ou lister des actions de sécurité

Les exemples suivants montrent comment obtenir ou lister des actions de sécurité.

Obtenir une action de sécurité

Pour obtenir une action de sécurité, saisissez une commande semblable à la suivante :

curl -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"
       -H "Authorization: Bearer $TOKEN"

La réponse renvoyée ressemble à celle-ci :

{
      "name": "ACTION_NAME",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
}

Lister des actions de sécurité

Pour lister toutes les actions de sécurité, saisissez une commande semblable à la suivante :

curl -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"
       -H "Authorization: Bearer $TOKEN"

Suspendre ou reprendre les actions de sécurité

Les exemples suivants montrent comment suspendre ou reprendre des actions de sécurité.

Suspendre toutes les actions de sécurité

Pour suspendre toutes les actions de sécurité, saisissez une commande semblable à la suivante :

curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"enabled": "false", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

La réponse renvoyée ressemble à celle-ci :

{
      "name": "organizations/ORG/environments/ENV/securityActionsConfig",
      "enabled": false,
      "updateTime": "2023-01-23T21:44:58.063807Z"
}

Reprendre les actions de sécurité suspendues

Pour reprendre des actions de sécurité suspendues, saisissez une commande semblable à la suivante :

curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{"enabled": "true", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

La réponse renvoyée ressemble à celle-ci :

{
      "name": "organizations/ORG/environments/ENV/securityActionsConfig",
      "enabled": true,
      "updateTime": "2023-01-23T21:44:58.063807Z"
}

Supprimer des actions de sécurité

Pour supprimer une action de sécurité, saisissez une commande semblable à la suivante :

curl -X DELETE "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"
       -H "Authorization: Bearer $TOKEN"