ממשק API של פרופילים וציוני אבטחה

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

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

סקירה כללית

בדף הזה מוסבר איך לנהל את ציוני האבטחה ואת פרופילי האבטחה (שנקראים גם 'פרופילים') של הערכת הסיכונים באמצעות ממשקי API. בדף הזה מוצגות דוגמאות לבקשות API.

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

דוגמאות ל-Risk Assessment v2 API

פרמטרים לדוגמאות של API בגרסה 2

בדוגמאות שבקטע הזה אפשר להשתמש בפרמטרים הבאים:

ORG הוא הארגון שלכם.
‫ENV היא הסביבה שבה רוצים לחשב את הציונים.
‫PROFILE_ID הוא שם הפרופיל. ‫PROFILE_ID יכול להיות ‫google-default או השם של פרופיל בהתאמה אישית שאתם יוצרים.
‫PROFILE_DESC (אופציונלי) הוא התיאור של הפרופיל. זה צריך להיות תיאור של הפרופיל שקריא לאנשים, ומספק מספיק מידע כדי להבדיל אותו מפרופילים אחרים.
‫PROXY_NAME: שם השרת הפרוקסי.
הערך של RESOURCES יכול להיות:
- ‫"include_all_resources":{} כדי לעקוב אחרי כל המשאבים בהיקף.
- ‫"include": { "resources": [{"type": "API_PROXY", "name": "PROXY_NAME"}]} כדי לעקוב אחרי שרת proxy אחד או יותר. לדוגמה, ‫"include": { "resources": [{"type": "API_PROXY", "name": "my-proxy-1"}]} to monitor the proxy called my-proxy-1.
‫SECURITY_MONITORING_CONDITION_ID: המזהה הייחודי של התנאי לניטור האבטחה. אם לא מספקים מזהה, נוצר מזהה ייחודי אוניברסלי (UUID) באופן אוטומטי.
‫$TOKEN הוא משתנה הסביבה של אסימון גישה ל-OAuth.

אחזור תוצאות של הערכת אבטחה של קבוצת משתמשים

למשתמשים עם התפקידים Security Admin או Security Viewer יש הרשאות לבצע חישוב של הערכת סיכונים אד-הוק. תצטרכו לציין את פרופיל האבטחה, את ההיקף (סביבת Apigee) ואת המשאבים שיוערכו. המשאבים יכולים להיות include_all_resources: true כדי לחשב את כל המשאבים בהיקף, או רק קומץ מהם. מידע נוסף על הפונקציונליות הזו מופיע במסמכי העזרה של ה-API של Apigee Management בקטע securityAssessmentResults.batchCompute.

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityAssessmentResults:batchCompute" \
       -X POST \
       -H "Authorization: Bearer $TOKEN" \
       -H 'Content-type: application/json' \
       -d '{
           "profile": "PROFILE_ID",
           "scope": "ENV",
           RESOURCES
  }'

זו תשובה פוטנציאלית לבקשה:

{
  "securityAssessmentResults": [
    {
      "resource": {
        "type": "API_PROXY",
        "name": "my-proxy-1",
        "resourceRevisionId": "1"
      },
      "createTime": "2023-11-22T04:49:29.418166Z",
      "scoringResult": {
        "severity": "HIGH",
        "failedAssessmentPerWeight": {
          "MINOR": 1
        },
        "assessmentRecommendations": {
          "cors-policies-check": {
            "displayName": "CORS policies check",
            "weight": "MAJOR",
            "recommendations": [
              {
                "description": "Check whether a CORS policy or CORS header in AssignMessage policy are present.",
                "link": {
                  "text": "Learn more",
                  "uri": "https://cloud.google.com/apigee/docs/api-platform/reference/policies/reference-overview-policy"
                }
              }
            ],
            "verdict": "FAIL",
            "scoreImpact": 100
          }
        },
        "dataUpdateTime": "2023-11-22T04:49:29.418166Z"
      }
    }
  ],
  "assessmentTime": "2023-11-22T04:49:29.418166Z"
}

ניהול פרופילי אבטחה

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

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

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfilesV2" \
      -H "Authorization: Bearer $TOKEN"

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfilesV2/PROFILE_ID" \
      -H "Authorization: Bearer $TOKEN"

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

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfilesV2?security_profile_v2_id=PROFILE_ID" \
       -X POST \
       -H "Authorization: Bearer $TOKEN" \
       -H 'Content-type: application/json' \
       -d '{
           "description": "PROFILE_DESC",
           "risk_assessment_type": "APIGEE",
           "profile_assessment_configs": {
               "auth-policies-check": {"weight": "MINOR"},
               "threat-policies-check": {"weight": "MODERATE"}
           }
        }'

עדכון של פרופיל אבטחה קיים בהתאמה אישית

כדי לעדכן פרופיל קיים, משתמשים בפקודה כמו:

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfilesV2/PROFILE_ID?update_mask=UPDATE_MASK" \
       -X PATCH \
       -H "Authorization: Bearer $TOKEN" \
       -H 'Content-type: application/json' \
       -d '{"description": "PROFILE_DESC"}'

אם המאפיין הזה קיים, הערך UPDATE_MASK יכול להיות אחד מהערכים הבאים: description,‏ profile_assessment_configs,‏ description,profile_assessment_configs או * (הכול). אם מציינים את מסכת העדכון *, הבקשה מעדכנת את כל השדות, ויכול להיות שהיא תסיר ערכים אם הם לא נכללים בבקשה.

אם לא מציינים את update_mask, רק השדות שצוינו בבקשת העדכון יעודכנו.

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

כדי למחוק פרופיל אבטחה מותאם אישית:

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfilesV2/PROFILE_ID" \
       -X DELETE \
       -H "Authorization: Bearer $TOKEN"

ניהול תנאי הניטור

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

יצירת תנאי חדש למעקב

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityMonitoringConditions?security_monitoring_condition_id=MONITORING_CONDITION_ID" \
       -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{
           "profile": "PROFILE_ID",
           "scope": "ENV",
           RESOURCES
       }'

התגובה יכולה להיראות כך:

{
  "name": "organizations/my-org/securityMonitoringConditions/my-condition",
  "createTime": "2025-11-22T05:02:16.089469Z",
  "updateTime": "2023-11-22T05:02:16.089469Z",
  "profile": "google-default",
  "scope": "test",
  "totalMonitoredResources": 4,
  "totalDeployedResources": 4,
  "includeAllResources": {}
}

הצגת רשימה של תנאי מעקב

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

curl -H "Authorization: Bearer $TOKEN" \
       "https://apigee.googleapis.com/v1/organizations/ORG/securityMonitoringConditions"

התשובה תהיה בפורמט הבא:

{
  "securityMonitoringConditions": [
    {
      "name": "organizations/my-org/securityMonitoringConditions/my-condition",
      "createTime": "2023-11-22T05:02:16.089469Z",
      "updateTime": "2025-11-22T05:02:16.089469Z",
      "profile": "google-default",
      "scope": "test",
      "totalMonitoredResources": 4,
      "totalDeployedResources": 4,
      "includeAllResources": {}
    }
  ]
}

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

curl -H "Authorization: Bearer $TOKEN" \
       "https://apigee.googleapis.com/v1/organizations/ORG/securityMonitoringConditions?filter=scope=ENV%20AND%20profile=PROFILE_ID"

אחזור של תנאי מעקב קיים

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

curl -H "Authorization: Bearer $TOKEN" \
       "https://apigee.googleapis.com/v1/organizations/ORG/securityMonitoringConditions/MONITORING_CONDITION_ID"

התשובה תהיה בפורמט הבא:

{
  "name": "organizations/my-org/securityMonitoringConditions/my-condition",
  "createTime": "2023-11-22T05:02:16.089469Z",
  "updateTime": "2025-11-22T05:02:16.089469Z",
  "profile": "google-default",
  "scope": "test",
  "totalMonitoredResources": 4,
  "totalDeployedResources": 4,
  "includeAllResources": {}
}

עדכון של תנאי מעקב קיים

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

curl -H "Authorization: Bearer $TOKEN" \
       "https://apigee.googleapis.com/v1/organizations/ORG/securityMonitoringConditions/MONITORING_CONDITION_ID?update_mask=CONDITION_UPDATE_MASK" -X PATCH -H "Content-Type: application/json" \
       -d  '{
       RESOURCES
  }'

הערך update_mask הוא אופציונלי. אם כוללים את CONDITION_UPDATE_MASK, הערך שלו יכול להיות include או include_all_resources. אם לא מציינים את update_mask מתעדכנים רק השדות שצוינו בבקשת העדכון.

התגובה עשויה להיראות כך:

{
  "name": "test-condition",
  "createTime": "2023-11-22T03:04:05Z",
  "updateTime": "2023-11-22T03:04:05Z",
  "profile": "google-default",
  "scope": "test",
  "include": {
    "resources": [{
      "type": "API_PROXY", "name": "PROXY_NAME"
    }]
  }
}

מחיקת תנאי מעקב

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

curl -H "Authorization: Bearer $TOKEN" \
       "https://apigee.googleapis.com/v1/organizations/ORG/securityMonitoringConditions/MONITORING_CONDITION_ID" \
       -X DELETE

הערכת סיכונים גרסה 1

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

מגבלות על ציוני אבטחה כשמשתמשים בממשקי ה-API

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

שדות קלט נתמכים ב-JSON:
- ‫timeRange: הערכים מוגבלים על ידי הקריטריונים שמתוארים בהפניה ל-API של computEnvironmentScores.
- filters: מידע נוסף מופיע בקטע מסננים שנתמכים ב-API.
- ‫pageSize: המספר המקסימלי של רכיבי משנה שיוחזרו בדף יחיד: 100.
אין תמיכה במסנני קלט מרובים.
אין תמיכה בשדה ההשפעה בתגובה. (השדה 'השפעה' מציין את ההשפעה הפוטנציאלית של ההמלצה הזו על הציון הכולל. הערך הזה מציין את מידת החשיבות של ההמלצה לשיפור הציון.)

למידע על מגבלות כלליות של ציון האבטחה שלא ספציפיות לשימוש בממשקי ה-API, אפשר לעיין במאמר בנושא מגבלות על ציון האבטחה גרסה 1.

פרמטרים בדוגמאות לקריאות ל-API

בקטעים הבאים מופיעות דוגמאות לקריאות ל-API, ואפשר להשתמש בפרמטרים הבאים:

ORG הוא הארגון שלכם.
‫ENV היא הסביבה שבה רוצים לחשב את הציונים.
‫ENVGROUP היא קבוצת סביבות שמכילה את הסביבה.
‫PROFILE_ID הוא שם הפרופיל. ‫PROFILE_ID יכול להיות default או השם של פרופיל בהתאמה אישית שיצרתם.
המחרוזת PROFILE_ID צריכה להכיל בין 1 ל-63 תווים, שיכולים להיות אותיות קטנות, ספרות (0-9) או מקפים. התו הראשון חייב להיות אות קטנה. התו האחרון צריך להיות אות קטנה או מספר.
‫PROXY_NAME: שם השרת הפרוקסי.
‫$TOKEN הוא משתנה הסביבה של אסימון גישה ל-OAuth.
‫timeRange הוא טווח הזמן של הציונים.

דוגמאות ל-Risk Assessment v1 API

מסננים שנתמכים ב-API

בטבלה הבאה מפורטים המסננים שנתמכים ב-API, ונתיבי הרכיבים שלהם.

מסנן	נתיב הרכיב
ציונים של סביבות	`/org@ORG/envgroup@ENVGROUP/env@ENV`
המקור מדרג את כל הרכיבים הבסיסיים	`/org@ORG/envgroup@ENVGROUP/env@ENV/source`
ציוני התנהלות פוגעת	`/org@ORG/envgroup@ENVGROUP/env@ENV/source/abuse`
ציונים לכל השרתים הפרוקסי	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies`
ציונים לשרת proxy ספציפי	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME`
ציוני מדיניות לשרת proxy ספציפי	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME/policies` `/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME/policies/individual`
ציוני מדיניות לבחירת רשת ספציפית דרך שרת proxy	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME/policies/individual/mediation`
ציונים של מדיניות האבטחה עבור שרת proxy ספציפי	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME/policies/individual/security`
ציוני מדיניות אימות עבור שרת proxy ספציפי	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME/policies/individual/security/auth`
ציון מדיניות CORS לשרת proxy ספציפי	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME/policies/individual/security/cors`
ציוני מדיניות בנושא איומים עבור שרת proxy ספציפי	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY_NAME/policies/individual/security/threat`
ציוני מדיניות לכל שרתי ה-proxy בסביבה	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies` `/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual`
ציוני מדיניות הגישור לכל שרתי ה-proxy בסביבה	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/mediation`
ציונים של מדיניות האבטחה לכל השרתים הפרוקסי בסביבה	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/security`
ציונים של מדיניות אימות לכל השרתים הפרוקסי בסביבה	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/security/auth`
ציוני מדיניות CORS לכל השרתים הפרוקסי בסביבה	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/security/cors`
ציוני מדיניות בנושא איומים לכל שרתי ה-proxy בסביבה	`/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/security/threat`

שימוש בפרופיל האבטחה שמוגדר כברירת מחדל

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

צירוף פרופיל האבטחה שמוגדר כברירת מחדל לסביבה

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/default/environments" \
       -X POST \
       -d '{"name": "ENV"}' \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

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

קבלת הגדרת פרופיל האבטחה שמוגדר כברירת מחדל

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/default" \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

ביטול ההצמדה של פרופיל האבטחה שמוגדר כברירת מחדל לסביבה

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

  curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/default/environments/ENV" \
         -X DELETE
         -H 'Content-type: application/json' \
         -H "Authorization: Bearer $TOKEN"

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

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

הגדרת הפרופיל באופן מפורש בגוף הבקשה.
מצרפים לשיחה קובץ JSON שמכיל את הגדרת הפרופיל.

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

השדות הבאים בדוגמאות של הקריאות ל-API מציינים את הפרופיל בהתאמה אישית:

‫description: תיאור של הפרופיל המותאם אישית.
profileConfig: רשימה של הקטגוריות שרוצים לכלול בפרופיל המותאם אישית. הוא יכול להיות כל קבוצת משנה של קטגוריות האבטחה הבאות:
- abuse
- authorization
- cors
- mtls
- mediation
- threat

הגדרת הפרופיל בגוף של קריאה ל-API

כדי להגדיר פרופיל בהתאמה אישית בגוף של קריאה ל-API, מזינים פקודה שדומה לפקודה הבאה:

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles?security_profile_id=PROFILE_ID" \
       -X POST \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d '{
         "description":"test custom profile",
         "profileConfig" : {
           "categories":[
             {"cors":{}},
             {"threat":{}}
           ]
         }
       }'

כך נוצר פרופיל מותאם אישית שכולל את הקטגוריות cors ו-threat, ומוחזרת תשובה כמו זו:

{
  "name": "PROFILE_ID",
  "revisionId": "1",
  "revisionCreateTime": "2023-07-17T18:47:08Z",
  "revisionUpdateTime": "2023-07-17T18:47:08Z",
  "scoringConfigs": [
    {
      "title": "json",
      "scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/security/threat/json",
      "description": "Check if JSONThreatProtection policy is configured."
    },
    {
      "title": "xml",
      "scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/security/threat/xml",
      "description": "Check if XMLThreatProtection policy is configured."
    },
    {
      "title": "cors",
      "scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@$proxy/policies/individual/security/cors",
      "description": "Check if CORS policy is configured."
    }
  ],
  "maxScore": 1200,
  "minScore": 200,
  "profileConfig": {
    "categories": [
      {
        "cors": {}
      },
      {
        "threat": {}
      }
    ]
  },
  "description": "test custom profile"
  }

הגדרת הפרופיל על ידי צירוף קובץ JSON לקריאה ל-API

אפשר גם להגדיר פרופיל אבטחה מותאם אישית על ידי צירוף קובץ JSON שמגדיר את הפרופיל לקריאה ל-API. לדוגמה, קודם יוצרים את קובץ ה-JSON הבא:

{
  "description": "test custom profile",
  "profileConfig" : {
    "categories":[
      {"cors":{}},
      {"threat" :{}},
    ]
  }
}

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles?security_profile_id=PROFILE_ID" \
       -X POST \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json" \
       -d @create_profile.json

כאשר create_profile.json הוא השם של קובץ ה-JSON שמתואר למעלה.

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

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

  curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID" \
         -X GET \
         -H "Authorization: Bearer $TOKEN" \
         -H "Content-Type: application/json"

ביטול ההצמדה של פרופיל אבטחה מותאם אישית לסביבה

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID/environments/ENV" \
       -X DELETE \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json"

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

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID" \
       -X DELETE \
       -H "Authorization: Bearer $TOKEN" \
       -H "Content-Type: application/json"

קבלת תוצאות לסביבה

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

איך מקבלים את כל הציונים של סביבה מסוימת

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID/environments/ENV:computeEnvironmentScores" \
       -X POST \
       -d '{"timeRange":
              {
                "startTime": "YYYY-MM-DDT00:00:00Z",
                "endTime": "YYYY-MM-DDT00:00:00Z"
              }
           }' \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

ב computeEnvironmentScores דף העזר יש תיאור של הבקשה והתשובה.

קבלת תוצאות מקור לסביבה

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID/environments/ENV:computeEnvironmentScores" \
       -X POST \
       -d '{"timeRange":
              {
                "startTime": "YYYY-MM-DDT00:00:00Z",
                "endTime": "YYYY-MM-DDT00:00:00Z"
              },
            "filters": [{"scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/source"}]
           }' \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

קבלת ציון ניצול לרעה במקור עבור סביבה

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID/environments/ENV:computeEnvironmentScores" \
       -X POST \
       -d '{"timeRange":
              {
                "startTime": "YYYY-MM-DDT00:00:00Z",
                "endTime": "YYYY-MM-DDT00:00:00Z"
              },
            "filters": [{"scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/source/abuse"}]
           }' \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

קבלת ציונים לכל שרתי ה-proxy בסביבה

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID/environments/ENV:computeEnvironmentScores" \
       -X POST \
       -d '{"timeRange":
              {
                "startTime": "YYYY-MM-DDT00:00:00Z",
                "endTime": "YYYY-MM-DDT00:00:00Z"
              },
            "filters": [{"scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/proxies"}]
           }' \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

קבלת ציונים לשרת proxy ספציפי בסביבה

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID/environments/ENV:computeEnvironmentScores" \
       -X POST \
       -d '{"timeRange":
              {
                "startTime": "YYYY-MM-DDT00:00:00Z",
                "endTime": "YYYY-MM-DDT00:00:00Z"
              },
            "filters": [{"scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/proxies/proxy@PROXY"}]
           }' \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

כאשר PROXY הוא ה-proxy שרוצים לקבל את הניקוד שלו.

קבלת ציונים ליעד ספציפי בסביבה

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

curl "https://apigee.googleapis.com/v1/organizations/ORG/securityProfiles/PROFILE_ID/environments/ENV:computeEnvironmentScores" \
       -X POST \
       -d '{"timeRange":
              {
                "startTime": "YYYY-MM-DDT00:00:00Z",
                "endTime": "YYYY-MM-DDT00:00:00Z"
              },
            "filters": [{"scorePath": "/org@ORG/envgroup@ENVGROUP/env@ENV/target@TARGET"}]
           }' \
       -H 'Content-type: application/json' \
       -H "Authorization: Bearer $TOKEN"

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

סקירה כללית

דוגמאות ל-Risk Assessment v2 API

פרמטרים לדוגמאות של API בגרסה 2

אחזור תוצאות של הערכת אבטחה של קבוצת משתמשים

ניהול פרופילי אבטחה

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

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

עדכון של פרופיל אבטחה קיים בהתאמה אישית

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

ניהול תנאי הניטור

יצירת תנאי חדש למעקב

הצגת רשימה של תנאי מעקב

אחזור של תנאי מעקב קיים

עדכון של תנאי מעקב קיים

מחיקת תנאי מעקב

הערכת סיכונים גרסה 1

מגבלות על ציוני אבטחה כשמשתמשים בממשקי ה-API

פרמטרים בדוגמאות לקריאות ל-API

דוגמאות ל-Risk Assessment v1 API

מסננים שנתמכים ב-API

שימוש בפרופיל האבטחה שמוגדר כברירת מחדל

צירוף פרופיל האבטחה שמוגדר כברירת מחדל לסביבה

קבלת הגדרת פרופיל האבטחה שמוגדר כברירת מחדל

ביטול ההצמדה של פרופיל האבטחה שמוגדר כברירת מחדל לסביבה

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

הגדרת הפרופיל בגוף של קריאה ל-API

הגדרת הפרופיל על ידי צירוף קובץ JSON לקריאה ל-API

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

ביטול ההצמדה של פרופיל אבטחה מותאם אישית לסביבה

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

קבלת תוצאות לסביבה

איך מקבלים את כל הציונים של סביבה מסוימת

קבלת תוצאות מקור לסביבה

קבלת ציון ניצול לרעה במקור עבור סביבה

קבלת ציונים לכל שרתי ה-proxy בסביבה

קבלת ציונים לשרת proxy ספציפי בסביבה

קבלת ציונים ליעד ספציפי בסביבה

ממשק API של פרופילים וציוני אבטחה