ניהול התוסף Advanced API Security

הדף הזה מתייחס ל-Apigee, אבל לא ל-Apigee Hybrid.

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

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

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

זמינות

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

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

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

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

ההרשאות הנדרשות

כדי לנהל את התוסף Advanced API Security, נדרשות ההרשאות הבאות:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

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

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

הפעלת התוסף Advanced API Security

אפשר להפעיל את התוסף Advanced API Security בסביבת Intermediate או Comprehensive של Apigee באמצעות ה-API.

כדי להפעיל את התוסף Advanced API Security באמצעות Apigee API, מזינים את הפקודה הבאה:

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"apiSecurityEnabled":true}'

כאשר:

  • ORG_NAME הוא השם של הארגון ב-Apigee עם תשלום לפי שימוש שבו רוצים להוסיף Advanced API Security לסביבות שעומדות בדרישות.
  • ENV_NAME הוא השם של סביבת Apigee שבה רוצים להפעיל את התוסף Advanced API Security.

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

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

החיוב על השימוש בתוסף Advanced API Security מתחיל ברגע שהתוסף מופעל.

השבתת התוסף Advanced API Security

אפשר להשבית את התוסף Advanced API Security בסביבת Intermediate או Comprehensive של Apigee באמצעות ה-API.

כדי להשבית את התוסף Advanced API Security באמצעות Apigee API, מזינים את הפקודה הבאה:

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"apiSecurityEnabled":false}'

כאשר:

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

צפייה בסטטוס של התוסף Advanced API Security בסביבה

אפשר לבדוק את הסטטוס של התוסף Advanced API Security בסביבת Intermediate או Comprehensive של Apigee באמצעות ה-API.

כדי לראות את הסטטוס של תוסף Advanced API Security בסביבה באמצעות Apigee API, מזינים את הפקודה הבאה:

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" 

כאשר:

  • ORG_NAME הוא השם של הארגון ב-Apigee עם תשלום לפי שימוש.
  • ENV_NAME הוא השם של סביבת Apigee.

התגובה מחזירה אובייקט ApiSecurityConfig שמייצג את הסטטוס הנוכחי של התוסף.

ניהול הנתונים של Advanced API Security

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

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

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