מוצג המסמך של 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">
מאפיין | תיאור | ברירת מחדל | נוכחות |
---|---|---|---|
אסינכרוני |
צריך להגדיר את הערך ההגדרה הזו משמשת רק לאופטימיזציה פנימית. |
false | אופציונלי |
continueOnError |
רוב כללי המדיניות צפויים להחזיר שגיאה כאשר מתרחש כשל. אם מגדירים את האפשרות הזו
ל- |
false | אופציונלי |
פעיל | קובע אם מדיניות נאכפת או לא. אם מוגדר הערך false ,
היא 'כבויה' ולא נאכפת (למרות שהמדיניות עדיין מצורפת
). |
true | אופציונלי |
שם |
השם הפנימי של המדיניות. יש הפניה לשם הזה ברכיבי שלב לצירוף את המדיניות לזרום. הערה: תווים שאפשר להשתמש בהם בשם מוגבלים ל:
|
לא רלוונטי | חובה |
<AccessToken> רכיב
מזהה את המשתנה שבו נמצא אסימון הגישה למחיקה. לדוגמה, אם
אסימון הגישה מצורף כדי לבקש הודעה בתור פרמטר שאילתה שנקרא "access_token", לציין
request.queryparam.access_token
אפשר להשתמש בכל משתנה חוקי שמפנה אל
ב-Assistant. לחלופין, הוא יכול להעביר את מחרוזת האסימון המילולית (מקרה נדיר).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
ברירת המחדל: | לא רלוונטי |
נוכחות: | <AccessToken> או <AuthorizationCode> הם
נדרש. |
סוג: | מחרוזת |
מאפיינים
מאפיין | תיאור | ברירת מחדל | נוכחות |
---|---|---|---|
אזכור |
משתנה של אסימון גישה. בדרך כלל, מאוחזרים ממשתנה זרימה. עבור
לדוגמה: |
לא רלוונטי | אופציונלי |
<AuthorizationCode> רכיב
מזהה את המשתנה שבו נמצא קוד ההרשאה למחיקה. לדוגמה, אם
קוד האימות מצורף לבקשת הודעה בתור פרמטר שאילתה שנקרא "קוד", יש לציין
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.