תחילת העבודה

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

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

בדף הזה מוסבר איך להתחיל להשתמש ב-Advanced API Security בארגונים עם מינוי ובארגונים עם תשלום לפי שימוש.

תפקידים והרשאות נדרשים

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

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

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

משימת דוח אבטחה	תפקידים נדרשים
הפעלה או השבתה של Advanced API Security	Apigee אדמין בארגון (`roles/apigee.admin`)
יצירת דוחות	Apigee Organization Admin (`roles/apigee.admin`) Apigee Security Admin (`roles/apigee.securityAdmin`)
הצגת הדוחות	Apigee Security Viewer (`roles/apigee.securityViewer`) Apigee Security Admin (`roles/apigee.securityAdmin`)

התפקידים הנדרשים להערכת סיכונים

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

משימת הערכת סיכונים	תפקידים נדרשים
יצירה, עדכון או מחיקה של פרופיל אבטחה בהתאמה אישית	Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee אדמין של הארגון (`roles/apigee.admin`)
צירוף או ניתוק של פרופיל אבטחה	Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee אדמין ארגוני (`roles/apigee.admin`)
צפייה בציוני אבטחה	‫Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee צפייה באבטחה (`roles/apigee.securityViewer`) Apigee אדמין ארגון (`roles/apigee.admin`)
הצגת רשימה של כל פרופילי האבטחה או קבלת פרופיל	‫Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee צפייה באבטחה (`roles/apigee.securityViewer`) Apigee אדמין ארגון (`roles/apigee.admin`)
יצירה, עדכון או מחיקה של תנאי ניטור לצורכי אבטחה	Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee אדמין של הארגון (`roles/apigee.admin`)
רשימה של תנאי ניטור לצורכי אבטחה וצפייה בהם	‫Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee צפייה באבטחה (`roles/apigee.securityViewer`) Apigee אדמין ארגון (`roles/apigee.admin`)
רשימה והצגה של מדדי תנאים של ניטור לצורכי אבטחה	אדמין ב-Monitoring (`roles/monitoring.admin`) עריכה ב-Monitoring (`roles/monitoring.editor`)
יצירה, עדכון או מחיקה של התראות מעקב	אילו תפקידים צריך (להתראות אבטחה)
הצגת התראות המעקב	ראו אירועים שקשורים למדיניות התראות מבוססת-מדדים: לפני שמתחילים

תפקידים והרשאות שנדרשים לזיהוי התנהלות פוגעת

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

משימת זיהוי התנהלות פוגעת	תפקידים והרשאות נדרשים
צפייה באירועים בממשק המשתמש של זיהוי שימוש לרעה	‫Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee צפייה באבטחה (`roles/apigee.securityViewer`) Apigee אדמין ארגון (`roles/apigee.admin`)
צפייה בתובנות מ-AI גנרטיבי לגבי אירוע	הרשאה `cloudaicompanion.instances.generateText`
הבעת הסכמה או ביטול הסכמה של ארגון לשימוש במודלים של למידת מכונה לזיהוי התנהלות פוגעת	הרשאה`apigee.securitySettings.update` אדמין לענייני אבטחה ב-Apigee (`roles/apigee.securityAdmin`) אדמין ארגון ב-Apigee (`roles/apigee.admin`)

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

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

משימת פעולת אבטחה	תפקידים נדרשים
יצירה, עריכה או מחיקה של הגדרות של פעולות אבטחה	Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee אדמין של הארגון (`roles/apigee.admin`)
צפייה בפעולות אבטחה או הצגת רשימה שלהן	Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee צפייה באבטחה (`roles/apigee.securityViewer`) Apigee אדמין ארגון (`roles/apigee.admin`)
בדיקת מצב האכיפה	Apigee אדמין לענייני אבטחה (`roles/apigee.securityAdmin`) Apigee צפייה באבטחה (`roles/apigee.securityViewer`) Apigee אדמין ארגון (`roles/apigee.admin`)

ניהול Advanced API Security בארגונים עם מינוי

כדי להשתמש ב-Advanced API Security בתור לקוחות מינוי, Advanced API Security צריכה להיות חלק מההרשאות של המינוי שלכם. מידע על הרשאות ב-Apigee כדי להוסיף את Advanced API Security להרשאות שלכם, צריך לפנות אל צוות המכירות של Apigee.

אחרי שתוכנית Advanced API Security תהיה חלק מההרשאות שלכם, תוכלו להפעיל אותה בארגון:

איך מקבלים את ההגדרה של תוספים ל-Apigee
הפעלת Advanced API Security בארגונים עם מינוי

אם אתם לא בטוחים אם אתם משתמשים בארגון Apigee עם מינוי או עם תשלום לפי שימוש, פנו לאדמין של ארגון Apigee שלכם.

אחזור ההגדרות של תוספים ל-Apigee

כדי להפעיל את Advanced API Security בארגון המנוי, קודם צריך לקבל את ההגדרה הנוכחית של תוספי Apigee באמצעות קריאה ל-API הבאה. בנוסף, תוכלו לראות אם כבר הפעלתם את התכונה 'Advanced API Security'.

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

איפה

‫ORG הוא שם הארגון.
‫$TOKEN הוא משתנה הסביבה של אסימון גישה ל-OAuth.

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

"addonsConfig": {

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

"apiSecurityConfig": {
          "enabled": true
      }

אם כן, Advanced API Security כבר מופעל בארגון. אחרת, צריך להפעיל אותו, כמו שמתואר בהמשך.

הפעלת Advanced API Security בארגונים עם מינויים

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

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      }
      <Other entries of your current add-ons configuration>
    }
  }'

איפה

‫ORG הוא שם הארגון.
‫$TOKEN הוא משתנה הסביבה של אסימון גישה ל-OAuth.
<Other entries of your current add-ons configuration> כולל את כל הרשומות האחרות של הגדרת התוספים הנוכחית של Apigee.

לדוגמה, אם ההגדרה הנוכחית של התוספים היא

"addonsConfig": {
  "integrationConfig": {
      "enabled":true
  },
  "monetizationConfig": {
      "enabled":true
  }
},

הפקודה להפעלת Advanced API Security תהיה

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      },
      "integrationConfig": {
          "enabled": true
      },
      "monetizationConfig": {
          "enabled": true
      }
    }
  }'

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

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

השבתה של Advanced API Security בארגונים עם מינוי

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

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": false
      }
     <Include current add-ons configuration>
    }
  }'

בדוגמה הבאה אפשר לראות את התגובה שמציינת שהפעולה מתבצעת:

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

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

ניהול Advanced API Security בארגונים עם תשלום לפי שימוש

אם אתם לקוחות עם תוכנית Pay-as-you-go, אתם יכולים להפעיל את Advanced API Security כתוסף בתשלום. מידע נוסף על הפעלת התוסף Advanced API Security בסביבות Apigee ברמת הביניים או ברמה המקיפה זמין במאמר ניהול התוסף Advanced API Security.

אם אתם לא בטוחים אם אתם משתמשים בארגון Apigee עם מינוי או עם תשלום לפי שימוש, פנו לאדמין של ארגון Apigee שלכם.

ניהול Advanced API Security בארגונים שמשתמשים בגרסת ניסיון

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

כדי להפעיל אותה, פועלים לפי ההוראות במאמר הפעלת Advanced API Security בארגונים עם מינוי.

אם אתם צריכים להשבית את התכונה, פועלים לפי ההוראות במאמר השבתת Advanced API Security בארגונים עם מינוי.

הגדרת Advanced API Security באמצעות Terraform

‫Apigee תומך בשימוש ב- כדי לנהל חלק מהפונקציות של Advanced API Security.

לדוגמה, אפשר להשתמש ב-Terraform כדי להגדיר:

מידע על הפונקציונליות הנתמכת כרגע זמין בקטע Apigee ב- Terraform Registry. שמות משאבים שקשורים ל-Advanced API Security מתחילים ב-google_apigee_security.

מידע כללי על שימוש ב-Terraform עם Apigee זמין במאמר שימוש ב-Terraform עם Apigee.

השלבים הבאים

אחרי שמפעילים את Advanced API Security, כדאי לעיין במאמרים הבאים: