אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
הגעת לדף הבית של OAuth ב-Apigee Edge. בדף הנחיתה הזה מופיעים קישורים למסמכי עזרה, לדוגמאות ולמקורות מידע אחרים שקשורים לשימוש ב-OAuth ב-Apigee Edge.
המסגרת של OAuth 2.0
אבטחת ממשקי ה-API באמצעות OAuth 2.0. בקטע הזה מפורטים מקורות מידע, קוד לדוגמה, סרטונים ונושאים אחרים שיעזרו לכם להשתמש ב-OAuth 2.0 ב-Apigee Edge.
מידע נוסף על OAuth 2.0
אוסף המשאבים הזה יעזור לכם להתעדכן בנושא OAuth 2.0.
-
מסמכי העזרה של Apigee:
- מבוא ל-OAuth 2.0 – סקירה של מושגים ותנאים בסיסיים של OAuth 2.0. מתמקדת בשימוש ב-OAuth ב-Apigee Edge.
- הדרכות והסמכות ב-Apigee:
- ב-Apigee יש הדרכה אונליין למפתחי API, כולל קורס בנושא אבטחת API שכולל OAuth.
-
מפרט IETF:
- מפרט IETF – מומלץ מאוד לקרוא את המפרט הזה ב-Apigee. הוא כולל מבוא בסיסי טוב וסקירה כללית מושגית.
-
ספר אלקטרוני וסרטון של Apigee:
- OAuth the Big Picture, ספר אלקטרוני חינמי של Apigee.
- OAuth the Big Picture, שידור אינטרנט חינמי של Apigee.
הטמעת תהליכי סוג המענק
כדי לעזור לכם להתחיל, ב-Apigee יש דוגמאות עובדות לכל סוג של הרשאה ב-OAuth 2.0. הדוגמאות מייצגות שיטות מומלצות וממחישות איך להטמיע סוגי הרשאות של OAuth ב-Apigee Edge.
פרטי הכניסה של הלקוח
- הטמעת סוג ההענקה 'פרטי כניסה של לקוח' – כאן נסביר על סוג ההענקה, עם דגש על השלבים שצריך לבצע כדי להטמיע את סוג ההענקה הזה ב-Apigee Edge.
- הטמעה לדוגמה – אפשר לעיין בדוגמה הזו במאגר api-samples שלנו ב-GitHub.
- אבטחת API (כולל OAuth)
קוד הרשאה
- הטמעת סוג ההקצאה של קוד ההרשאה – כאן נסביר על סוג ההקצאה, עם דגש על השלבים שצריך לבצע כדי להטמיע את סוג ההקצאה הזה ב-Apigee Edge.
- הטמעה לדוגמה – כדאי לעיין בדוגמה המתקדמת הזו במאגר api-samples שלנו ב-GitHub. אפשר לשכפל את הדוגמה, לפרוס אותה ולהריץ אותה. פרטים נוספים זמינים בקובץ README. הוא כולל אפליקציית כניסה חזקה שמאמתת משתמשים ומנהלת תקשורת מאובטחת עם שרת ההרשאות.
משתמע
- בקשת אסימונים: סוג הענקה משתמע – מוסבר איך לבקש אסימונים עם סוג הענקה משתמע.
פרטי הכניסה של סיסמת בעלי המשאב
- הטמעה של סוג ההרשאה 'סיסמה' – כאן נסביר על סוג ההרשאה, עם דגש על השלבים שצריך לבצע כדי להטמיע את סוג ההרשאה הזה ב-Apigee Edge.
נושאי מדריכים מהירים
בנושאים הבאים מוסבר בהרחבה על משימות נפוצות ב-OAuth 2.0, ומפורטים השלבים לביצוען:
- הגדרת שרת proxy חדש ל-API
- רישום אפליקציות לקוח
- קבלת פרטי הכניסה של הלקוח
- הגדרת מדיניות ונקודות קצה של OAuth
- בקשה לקבלת אסימונים וקודי אימות
- התאמה אישית של אסימוני גישה
- אישור וביטול של אסימוני גישה
- שליחת אסימון גישה
- אימות של אסימוני גישה
- עבודה עם היקפים
- נושאים מתקדמים
מקורות מידע בנושא מדיניות ו-API
בנושאים האלה מפורט מידע על המדיניות ועל ממשקי ה-API שתומכים ישירות ב-OAuth 2.0 ב-Edge.
-
OAuthV2 Policies – המדיניות הזו מאפשרת לכם להטמיע ולהתאים אישית את ארבעת סוגי ההענקות של OAuth 2.0 ב-Apigee Edge:
- מדיניות OAuthV2 – הלב של ההטמעה של OAuth 2.0 ב-Apigee Edge. בעזרתו אפשר להגדיר ב-Apigee Edge 'פעולות' של OAuth 2.0 שיוצרות אסימוני גישה ואסימוני רענון, מנפיקות קודי הרשאה ומאמתות אסימונים. הנושא הזה כולל דוגמאות קוד שיעזרו להמחיש איך הדברים פועלים.
- מדיניות GetOAuthV2Info – אחזור מאפיינים של אסימונים והפיכתם לזמינים למדיניות ולקוד שפועלים בשרת proxy ל-API. סוג המדיניות הזה יכול להיות שימושי כשצריך להגדיר התנהגות מותנית דינמית על סמך ערך באסימון גישה. אפשר לעיין גם במאמר התאמה אישית של אסימוני גישה.
- מדיניות SetOAuthV2Info – עדכון הפרופיל של אסימון גישה. לדוגמה, יכול להיות שתרצו להטמיע תג ייחודי לעסק שלכם. אפשר לעיין גם במאמר התאמה אישית של אסימוני גישה.
- קודי שגיאה של OAuth 2.0
- ממשקי OAuth 2.0 – Apigee מספקת את ממשקי ה-API האלה לעבודה עם נקודות קצה של OAuth 2.0.
המסגרת של OAuth 1.0a
OAuth 1.0a מגדיר פרוטוקול סטנדרטי שמאפשר למשתמשי האפליקציה להעניק לאפליקציות הרשאה לצרוך ממשקי API בשמם, בלי לחייב אותם לחשוף את הסיסמאות שלהם לאפליקציה בתהליך.
סימוכין למדיניות של OAuth 1.0a
במאמר העזרה בנושא מדיניות OAuthV1 מוסבר איך להגדיר מדיניות של OAuth v1.0a. סוג המדיניות OAuthV1 אחראי ליצירת אסימוני בקשה, ליצירת אסימוני גישה ולאימות אסימוני גישה על סמך מפרט OAuth 1.0a.
ממשקי API של OAuth 1.0a
ב-Apigee יש ממשקי API לעבודה עם נקודות קצה של OAuth 1.0a.
דוגמה ל-OAuth 1.0a ב-GitHub
דוגמה לשרת proxy של API ב-GitHub שממחישה הגדרה עם שלוש רגליים של OAuth 1.0a. אפשר להוריד ולהריץ את הקוד הזה.
שם | תיאור |
---|---|
oauth10a-3legged | הדגמה של תצורה עם שלוש רגליים של OAuth 1.0a. |