Security Actions API

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

בדף הזה מוסבר איך לנהל פעולות אבטחה באמצעות ממשקי הניהול של Apigee. לסקירה כללית של הפונקציונליות של פעולות האבטחה, כולל מגבלות וזמני אחזור, אפשר לעיין במאמר סקירה כללית של פעולות האבטחה וממשק המשתמש שלהן.

אפשר לגשת לכל התכונות של פעולות האבטחה באמצעות ממשקי הניהול של Apigee. מידע על כל הפקודות הזמינות מופיע ב הפניית API של Security Actions. בדף הזה מוצגות דוגמאות לחלק מהפקודות הזמינות.

משתנים שמשמשים בדוגמאות

הדוגמאות בדף הזה יכולות לכלול את המשתנים הבאים:

  • ORG הוא הארגון.
  • ‫ENV היא הסביבה של פעולת האבטחה.
  • ‫ACTION_NAME הוא השם של פעולת האבטחה.

הגדרת כמה סוגי תנאים

אפשר לכלול סוג אחד או שניים של תנאים (כמו רשימות של כתובות IP ומספרי ASN) בפעולת אבטחה אחת.

כדי להגדיר פעולת אבטחה עם שני סוגי תנאים, צריך לכלול כמה מפתחות תנאים באובייקט conditionConfig. לדוגמה:

"conditionConfig": {"ipAddressRanges": ["100.0.225.0"], "asns": ["10578"]}

בדוגמה הזו מוצגים שני סוגי תנאים בפעולת דחייה:

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": {"responseCode": 404}, "conditionConfig": {"ipAddressRanges": ["100.0.225.0"], "asns": ["10578"]}}'

יצירת פעולות אבטחה

בקטע הזה מופיעות דוגמאות לאופן שבו אפשר ליצור פעולות אבטחה עם סוגים שונים של פעולות.

יצירת פעולת דחייה

כדי ליצור פעולת דחייה, מזינים פקודה שדומה לפקודה הבאה:

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": {"responseCode": 404}, "conditionConfig": {"ipAddressRanges": ["100.0.225.0"]}}'

הפעולה הזו יוצרת פעולת אבטחה שדוחה בקשות לכתובות ה-IP שמופיעות ב-ipAddressRanges ומחזירה קוד תגובה 404.

יצירת פעולה לסימון

כדי ליצור פעולה לסימון, מזינים פקודה שדומה לפקודה הבאה:

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"}]}, "conditionConfig": {"ipAddressRanges": ["100.0.230.0"]}}'

הפעולה הזו יוצרת פעולת אבטחה שמסמנת בקשות מכתובות ה-IP שמופיעות ב-ipAddressRanges ומוסיפה כותרת senseflag עם הערך flagvalue.

יצירת פעולת אישור

כדי ליצור פעולת הרשאה, מזינים פקודה שדומה לפקודה הבאה:

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": {}, "conditionConfig": {"ipAddressRanges": ["100.0.220.0", "200.0.0.0"]}}'

כך נוצרת פעולת אבטחה שמאפשרת בקשות מכתובות ה-IP שמפורטות ב-ipAddressRanges.

עריכה של פעולות אבטחה

בקטע הזה מופיעה דוגמה לעריכה של הגדרת פעולת אבטחה קיימת. בדפים הפעלה או השבתה של פעולת אבטחה ומחיקה של פעולת אבטחה אפשר לראות דוגמאות לסוגים האלה של שינויים.

עריכת פעולת דחייה

בקטע הזה מוצגת דוגמה לעריכה של פעולת דחייה. ממשקי ה-API תומכים גם בעריכה של סוגי פעולות אחרים.

‫update_mask יכול לכלול כל אחת מהאפשרויות הבאות: description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,* (הכול), או להיות מושמט (ברירת המחדל היא הכול).

מידע נוסף על ערכים אפשריים כשעורכים פעולות זמין ב מאמרי העזרה של Security Actions API.

  curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME?update_mask=deny,conditionConfig" \
         -H "Authorization: Bearer $TOKEN" \
         -d '{"deny": {"responseCode": 404}, "conditionConfig": {"ipAddressRanges": ["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
           }
         }

הפעלה או השבתה של פעולת אבטחה

בדוגמאות הבאות מוצגות קריאות ל-API להפעלה או להשבתה של פעולות אבטחה.

הפעלת פעולת אבטחה

כדי להפעיל פעולת אבטחה, מזינים פקודה דומה לזו:

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

התגובה שמתקבלת נראית כך:

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

השבתת פעולת אבטחה

כדי להשבית פעולת אבטחה, מזינים פקודה דומה לפקודה הבאה:

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

התגובה שמתקבלת נראית כך:

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

קבלת רשימה של פעולות אבטחה

בדוגמאות הבאות אפשר לראות איך מקבלים או מציגים רשימה של פעולות אבטחה

קבלת פעולת אבטחה

כדי לקבל פעולת אבטחה, מזינים פקודה שדומה לפקודה הבאה:

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

התגובה שמתקבלת נראית כך:

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

הצגת רשימה של פעולות אבטחה

כדי להציג רשימה של כל פעולות האבטחה, מזינים פקודה דומה לזו:

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

השהיה או המשך של פעולות אבטחה

בדוגמאות הבאות אפשר לראות איך משהים או מפעילים מחדש פעולות אבטחה

השהיית כל פעולות האבטחה

כדי להשהות את כל פעולות האבטחה, מזינים פקודה דומה לזו:

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

התגובה שמתקבלת נראית כך:

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

המשך של פעולות אבטחה שהושהו

כדי להמשיך פעולות אבטחה שהושהו, מזינים פקודה דומה לזו:

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

התגובה שמתקבלת נראית כך:

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

מחיקת פעולות אבטחה

כדי למחוק פעולת אבטחה, מזינים פקודה דומה לזו:

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