כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
מה
מחיקת קוד ההרשאה או אסימון הגישה של OAuth V2 שצוינו.
דוגמאות
מחיקה של אסימון הגישה
לפניכם מדיניות לדוגמה שמשמשת למחיקת אסימון גישה מסוג OAuth 2.0. בדוגמה הבאה מחפשים את אסימון הגישה שיש למחוק בהודעת הבקשה על ידי חיפוש כותרת בשם access_token
.
<DeleteOAuthV2Info name="DeleteAccessToken"> <AccessToken ref="request.header.access_token"></AccessToken> </DeleteOAuthV2Info>
מחיקת קוד האימות
בהמשך מופיעה מדיניות לדוגמה שמשמשת למחיקת קוד הרשאה של OAuth 2.0. הדוגמה הבאה
מאתרת את קוד ההרשאה שיש למחוק בהודעת הבקשה על ידי חיפוש פרמטר שאילתה שנקרא
code
.
<DeleteOAuthV2Info name="DeleteAuthCode"> <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode> </DeleteOAuthV2Info>
הפניה לרכיב
בהפניה לרכיב מתוארים הרכיבים והמאפיינים של מדיניות DeleteOAuthV2Info.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="DeleteOAuthV2Info-1"> <DisplayName>Delete OAuth v2.0 Info 1</DisplayName> <AccessToken ref={some-variable}></AccessToken> <!--<AuthorizationCode ref={some-variable}></AuthorizationCode>--> <Attributes/> </DeleteOAuthV2Info
מאפייני<DeleteOAuthV2Info>
<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
מאפיין | תיאור | ברירת המחדל | נוכחות |
---|---|---|---|
async |
צריך להגדיר את הערך ההגדרה הזו משמשת רק לאופטימיזציה פנימית. |
false | אופציונלי |
continueOnError |
רוב כללי המדיניות צפויים להחזיר שגיאה במקרה של כשל. אם מגדירים את
המאפיין הזה כ- |
false | אופציונלי |
פעיל | קובעת אם מדיניות מסוימת נאכפת או לא. אם המדיניות מוגדרת לערך false ,
המדיניות תהיה 'מושבתת' ולא נאכפת (למרות שהמדיניות עדיין מצורפת לתהליך). |
true | אופציונלי |
name |
השם הפנימי של המדיניות. ברכיבי השלב יש הפניה לשם הזה כדי לצרף את המדיניות לזרימה. הערה: התווים שאפשר להשתמש בהם בשם מוגבלים ל:
|
לא רלוונטי | חובה |
רכיב <AccessToken>
מזהה את המשתנה שבו נמצא אסימון הגישה למחיקה. לדוגמה, אם
אסימון הגישה מצורף כדי לבקש הודעה כפרמטר של שאילתה בשם 'access_token', צריך לציין את
request.queryparam.access_token
. אפשר להשתמש בכל משתנה חוקי שמפנה
לאסימון. לחלופין, יכולים לעבור במחרוזת האסימון המילולית (מקרה נדיר).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
ברירת מחדל: | לא רלוונטי |
נוכחות: | חובה להזין <AccessToken> או <AuthorizationCode> . |
סוג: | מחרוזת |
מאפיינים
מאפיין | תיאור | ברירת המחדל | נוכחות |
---|---|---|---|
ר' |
משתנה של אסימון גישה. הם מאוחזרים בדרך כלל ממשתנה זרימה. לדוגמה: |
לא רלוונטי | אופציונלי |
אלמנט <AuthorizationCode>
מזהה את המשתנה שבו נמצא קוד ההרשאה למחיקה. לדוגמה, אם
קוד ההרשאה מצורף כדי לבקש הודעה כפרמטר של שאילתה בשם 'code', צריך לציין את
request.queryparam.code
. אפשר להשתמש בכל משתנה חוקי שמפנה לאסימון.
לחלופין, יכולים לעבור במחרוזת האסימון המילולית (מקרה נדיר).
<AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
ברירת מחדל: | לא רלוונטי |
נוכחות: | חובה להזין <AccessToken> או <AuthorizationCode> . |
סוג: | מחרוזת |
מאפיינים
מאפיין | תיאור | ברירת המחדל | נוכחות |
---|---|---|---|
ר' |
משתנה של אסימון גישה. הם מאוחזרים בדרך כלל ממשתנה זרימה. לדוגמה: |
לא רלוונטי | אופציונלי |
<DisplayName> אלמנט
שם בשפה טבעית שמסמן את המדיניות בעורך ה-proxy של ממשק המשתמש לניהול. אם לא צוין מזהה, המערכת תשתמש במאפיין של שם המדיניות.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
ברירת מחדל: | ערך המאפיין name של המדיניות. |
נוכחות: | אופציונלי |
סוג: | מחרוזת |
הפניה לשגיאות
בקטע הזה מתוארים קודי התקלות והודעות השגיאה שמוחזרים, ומשתני השגיאה שמוגדרים על ידי Edge כשהמדיניות הזו גורמת לשגיאה. חשוב לדעת אם אתם מפתחים כללים לתיקון תקלות. מידע נוסף זמין במאמר מה צריך לדעת על שגיאות מדיניות ועל טיפול בפגמים.
שגיאות בזמן ריצה
השגיאות האלה יכולות להתרחש כשהמדיניות מופעלת.
קוד שגיאה | סטטוס HTTP | סיבה |
---|---|---|
steps.oauth.v2.invalid_access_token |
401 | אסימון הגישה שנשלח למדיניות אינו חוקי. |
steps.oauth.v2.invalid_request-authorization_code_invalid |
401 | קוד ההרשאה שנשלח למדיניות לא תקין. |
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound |
401 | מידע על פתרון השגיאה הזו זמין בפוסט הזה בקהילת Apigee. |
שגיאות בפריסה
יש לעיין בהודעה שמדווחת בממשק המשתמש לקבלת מידע על שגיאות פריסה.
משתני שבר
המשתנים האלה מוגדרים כשהמדיניות הזו גורמת לשגיאה בזמן הריצה.
משתנים | מיקום | דוגמה |
---|---|---|
fault.name="fault_name" |
fault_name הוא שם התקלה, כפי שמפורט בטבלה שגיאות זמן ריצה שלמעלה. שם הטעות הוא החלק האחרון בקוד השגיאה. | fault.name = "invalid_access_token" |
oauthV2.policy_name.failed |
policy_name הוא השם שצוין על ידי המשתמש של המדיניות שגרמה לשגיאה. | oauthV2.DeleteTokenInfo.failed = true |
oauthV2.policy_name.fault.name |
policy_name הוא השם שצוין על ידי המשתמש של המדיניות שגרמה לשגיאה. | oauthV2.DeleteTokenInfo.fault.name = invalid_access_token |
oauthv2.policy_name.fault.cause |
policy_name הוא השם שצוין על ידי המשתמש של המדיניות שגרמה לשגיאה. | oauthV2.DeleteTokenInfo.cause = Invalid Access Token |
דוגמה לשגיאה
{ "fault": { "faultstring": "Invalid Access Token", "detail": { "errorcode": "keymanagement.service.invalid_access_token" } } }
דוגמה לכלל שגיאה
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults"> <Step> <Name>AM-InvalidTokenResponse</Name> </Step> <Condition>(fault.name = "invalid_access_token")</Condition> </FaultRule>
סכימה
כל סוג מדיניות מוגדר על ידי סכימת XML (.xsd
). לידיעתך, סכימות המדיניות זמינות ב-GitHub.