API des actions de sécurité

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

Consultez la documentation d' Apigee Edge.

En plus d'utiliser les actions de sécurité dans l'interface utilisateur d'Apigee, vous pouvez également accéder à toutes les fonctionnalités des actions de sécurité via l'API Apigee.

Limites des actions de sécurité

Les actions de sécurité sont appliquées au niveau de l'environnement Apigee. Pour chaque environnement, les actions de sécurité présentent les limites suivantes :

  • Au maximum, 1 000 actions sont autorisées pour un environnement à tout moment.
  • Vous pouvez ajouter au maximum cinq en-têtes de signalement pour chaque action.

Latences

Les actions de sécurité présentent les latences suivantes :

  • Lorsque vous créez une action de sécurité, la prise en compte de celle-ci peut prendre jusqu'à 10 minutes. Une fois qu'une action a pris effet et a été appliquée à un certain trafic d'API, vous pouvez consulter les effets de l'action sur la page Détails des actions de sécurité. Remarque : Même si l'action a pris effet, vous ne pouvez pas déterminer à partir de la page des détails de l'action de sécurité, sauf si l'action a été appliquée à un certain trafic d'API.
  • Les actions de sécurité activées entraînent une légère augmentation (moins de 2 %) du temps de réponse du proxy d'API.

Créer des actions de sécurité

Les exemples suivants montrent comment créer des actions de sécurité à l'aide d'appels d'API. Dans tous les exemples :

  • 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 une action de refus

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

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -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 répertorié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 d'option, saisissez une commande semblable à celle-ci :

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
        -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 répertorié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 -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
        -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 répertoriées après ip_address_ranges.

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

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

Activer une action de sécurité

Pour activer une action de sécurité, saisissez une commande semblable à celle-ci :

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"

La réponse renvoyée est semblable à celle-ci :

{
      "name": "ACTION_ALLOW",
      "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 à celle-ci :

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"

La réponse renvoyée est semblable à 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 répertorier des actions de sécurité.

Obtenir une action de sécurité

Pour obtenir une action de sécurité, saisissez une commande semblable à celle-ci :

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"

La réponse renvoyée est semblable à 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 répertorier toutes les actions de sécurité, saisissez une commande semblable à celle-ci :

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"

Suspendre ou reprendre les actions de sécurité

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

Suspendre toutes les actions de sécurité

Pour suspendre toutes les actions de sécurité, saisissez une commande semblable à celle-ci :

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

La réponse renvoyée est semblable à celle-ci :

{
      "name": "organizations//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 à celle-ci :

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

La réponse renvoyée est semblable à celle-ci :

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