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

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

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

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

נקודת קצה (endpoint) מסוג 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, נדרשת מדיניות לטיפול בסוג כזה של בקשה. כפי שאפשר להבין מהבקשה, המדיניות צריכה לתמוך בסוג ההרשאה client credentials, והמדיניות צריכה לפעול בנתיב /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 מוסיף פרוקסי לדוגמה של נקודת קצה מסוג OAuth2 לכל ארגון חדש שהוא יוצר. אם תבדקו, תמצאו בארגון שלכם פרוקסי בשם oauth.

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

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

   Edge

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

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

   ‫Classic Edge (ענן פרטי)

   כדי לגשת לדף API Proxies באמצעות ממשק המשתמש הקלאסי של Edge:

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

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

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

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

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

בקשת טוקנים לגישה וקודי הרשאה