API Security Actions

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Questa pagina descrive come gestire le azioni di sicurezza utilizzando le API Apigee Management. Per una panoramica della funzionalità delle azioni di sicurezza, incluse limitazioni e latenze, consulta la Panoramica e UI delle azioni di sicurezza.

Puoi accedere a tutte le funzionalità delle azioni di sicurezza tramite le API di gestione Apigee. Consulta il riferimento dell'API Security Actions per informazioni su tutti i comandi disponibili. Questa pagina mostra esempi di alcuni dei comandi disponibili.

Variabili utilizzate negli esempi

Gli esempi in questa pagina possono includere queste variabili:

  • ORG è l'organizzazione.
  • ENV è l'ambiente per l'azione di sicurezza.
  • ACTION_NAME è il nome dell'azione di sicurezza.

Crea azioni di sicurezza

Questa sezione fornisce esempi su come creare azioni di sicurezza con diversi tipi di azioni.

Crea un'azione di negazione

Per creare un'azione di negazione, inserisci un comando simile al seguente:

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

In questo modo viene creata un'azione di sicurezza che nega l'accesso alle richieste agli indirizzi IP elencati dopo ip_address_ranges e restituisce un codice di risposta 404.

Crea un'azione di flag

Per creare un'azione di flag, inserisci un comando simile al seguente:

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

In questo modo viene creata un'azione di sicurezza che contrassegna le richieste provenienti dagli indirizzi IP elencati dopo ip_address_ranges e aggiunge un'intestazione senseflag con il valore flagvalue.

Creare un'azione di autorizzazione

Per creare un'azione di autorizzazione, inserisci un comando simile al seguente:

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

In questo modo viene creata un'azione di sicurezza che consente le richieste provenienti dagli indirizzi IP elencati dopo ip_address_ranges.

Modifica le azioni di sicurezza

Questa sezione fornisce un esempio di come modificare una configurazione di azione di sicurezza esistente. Consulta Attivare o disattivare un'azione di sicurezza o Eliminare un'azione di sicurezza per visualizzare esempi di questi tipi di modifiche.

Modificare un'azione di negazione

Questa sezione mostra un esempio di modifica di un'azione di negazione. Le API supportano anche la modifica degli altri tipi di azioni.

update_mask può includere una qualsiasi di queste opzioni: description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,* (tutto) o essere omesso (il valore predefinito è tutto).

Per ulteriori informazioni sui valori potenziali durante la modifica delle azioni, consulta la documentazione di riferimento dell'API Security Actions.

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

Attivare o disattivare un'azione di sicurezza

I seguenti esempi mostrano le chiamate API per abilitare o disabilitare le azioni di sicurezza.

Attivare un'azione di sicurezza

Per abilitare un'azione di sicurezza, inserisci un comando simile al seguente:

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

Viene restituita una risposta simile alla seguente:

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

Disattivare un'azione di sicurezza

Per disattivare un'azione di sicurezza, inserisci un comando simile al seguente:

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

Viene restituita una risposta simile alla seguente:

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

Ottenere o elencare le azioni di sicurezza

I seguenti esempi mostrano come ottenere o elencare le azioni di sicurezza

Ricevere un'azione di sicurezza

Per ottenere un'azione di sicurezza, inserisci un comando simile al seguente:

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

Viene restituita una risposta simile alla seguente:

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

Elenca le azioni di sicurezza

Per elencare tutte le azioni di sicurezza, inserisci un comando simile al seguente:

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

Mettere in pausa o riprendere le azioni di sicurezza

I seguenti esempi mostrano come mettere in pausa o riprendere le azioni di sicurezza

Metti in pausa tutte le azioni di sicurezza

Per mettere in pausa tutte le azioni di sicurezza, inserisci un comando simile al seguente:

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

Viene restituita una risposta simile alla seguente:

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

Riprendere le azioni di sicurezza in pausa

Per riprendere le azioni di sicurezza in pausa, inserisci un comando simile al seguente:

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

Viene restituita una risposta simile alla seguente:

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

Elimina azioni di sicurezza

Per eliminare un'azione di sicurezza, inserisci un comando simile al seguente:

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