הסבר על נקודות קצה של OAuth

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

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

מהי נקודת קצה מסוג OAuth2?

נקודת קצה מסוג OAuth2 היא כתובת URL שהלקוחות קוראים כדי לבקש אסימוני OAuth (או קודי אימות). הנה בקשה לדוגמה לאסימון גישה:

$ curl -i -H 'ContentType: x-www-form-urlencoded' \
-X POST 'https://docs-test.apigee.net/oauth/client_credential/accesstoken' \
-d 'grant_type=client_credentials' \
-H 'Authorization: Basic c3FIOG9vSGV4VHo4QzAySVg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ'

כדי לטפל בבקשות מהסוג הזה, נדרשת מדיניות בסביבת Apigee Edge. ככל שניתן להסיק מהבקשה, המדיניות חייבת לתמוך ב"פרטי הכניסה של הלקוח" סוג המענק, וגם המדיניות חייבת להתבצע בנתיב /oauth/client_credentials/accesstoken.

המדיניות הנכונה במקרה הזה היא מדיניות OAuthV2, שהוגדרה לפעול בתהליך כמו הדוגמה הבאה שממחישה (כאשר שם המדיניות הוא GenerateAccessTokenClient):

        <Flow name="AccessTokenClientCredential">
            <Description/>
            <Request>
                <Step>
                    <FaultRules/>
                    <Name>GenerateAccessTokenClient</Name>
                </Step>
            </Request>
            <Response/>
            <Condition>(proxy.pathsuffix MatchesPath &quot;/accesstoken&quot;) and (request.verb = &quot;POST&quot;)</Condition>
        </Flow>

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

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

כברירת מחדל, מערכת Apigee מוסיפה דוגמה לשרת proxy של נקודת קצה ב-OAuth2 לכל ארגון חדש שהוא יוצר. אם תחפשו אותו, תראו בארגון שלכם שרת proxy בשם oauth.

כדי למצוא את שרת ה-proxy הזה:

1. ניגשים לדף ממשקי ה-proxy ל-API, כמו שמתואר בהמשך.

   Edge

   כדי לגשת לדף שרתי ה-proxy ל-API באמצעות ממשק המשתמש של Edge:

   1. נכנסים לכתובת apigee.com/edge.
   2. בוחרים באפשרות פיתוח > שרתי proxy ל-API בסרגל הניווט הימני.
   3. לוחצים על +Proxy.

   Classic Edge (ענן פרטי)

   כדי לגשת לדף שרתי ה-proxy ל-API באמצעות ממשק המשתמש של Classic Edge:

   1. יש להיכנס אל http://ms-ip:9000, כאשר ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
   2. בוחרים באפשרות APIs > ממשקי API ל-API בסרגל הניווט העליון.
2. ברשימת שרתי ה-proxy, בוחרים את השירות שנקרא oauth.
3. בדף הסקירה הכללית של שרת ה-Proxy, בוחרים בכרטיסייה פיתוח כדי להציג את שרת ה-Proxy. ולבחון את כללי המדיניות ואת התהליכים בשרת ה-proxy.

שיטה מומלצת: יצירת שרת proxy משלכם לנקודת קצה (endpoint) מסוג OAuth2

שרת ה-proxy ל-oauth שמוגדר כברירת מחדל מוגבל: הוא תומך רק בפרטי הכניסה של הלקוח סוג המענק. שרת ה-proxy הזה נועד לשמש לדוגמה בלבד. בסביבת ייצור, צריך ליצור שרת proxy שמגדירה את נקודות הקצה מסוג OAuth2 שעומדות בדרישות.

הערה חשובה אחת: שרת proxy שמגדיר נקודות קצה של OAuth2 הוא בדרך כלל שרת proxy ללא יעד. שרת ה-proxy פועל כשירות שמופעל ב-ProxyEndpoint וחוזר ישירות חזרה ללקוח.

נושאים קשורים

בקשת אסימוני גישה ו קודי הרשאה