מדיניות DeleteOAuthV2Info

אתם צופים במסמכי התיעוד של 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">
מאפיין תיאור ברירת מחדל נוכחות
אסינכרוני

הערך true מציין שהמדיניות תופעל במאגר שרשורים שונה מהמאגר שמטפל בתהליך הבקשה/התגובה. ברירת המחדל היא false.

ההגדרה הזו משמשת רק לאופטימיזציה פנימית.

 false אופציונלי
continueOnError

ברוב המקרים, המדיניות אמורה להחזיר שגיאה כשמתרחש כשל. אם מגדירים את המאפיין הזה לערך true, הביצוע של התהליך נמשך גם אם הוא נכשל.

 false אופציונלי
פעיל ההגדרה קובעת אם המדיניות נאכפת או לא. אם המדיניות מוגדרת לערך false, המדיניות מושבתת ולא נאכפת (גם אם היא עדיין משויכת לזרימה). true אופציונלי
שם

השם הפנימי של המדיניות. השם הזה מוזכר ברכיבי Step כדי לצרף את המדיניות ל-Flow.

הערה: התווים שאפשר להשתמש בהם בשם מוגבלים ל: A-Z0-9._\-$ %. ממשק המשתמש לניהול אוכף הגבלות נוספות, כמו הסרה אוטומטית של תווים שהם לא אלפאנומריים.

 לא רלוונטי חובה

אלמנט <AccessToken>

מזהה את המשתנה שבו נמצא אסימון הגישה שרוצים למחוק. לדוגמה, אם אסימון הגישה מצורף להודעת הבקשה כפרמטר שאילתה בשם access_token, מציינים request.queryparam.access_token. אפשר להשתמש בכל משתנה תקין שמפנה לטוקן. או להעביר את מחרוזת האסימון המילולית (מקרה נדיר).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
ברירת מחדל: לא רלוונטי
נוכחות: צריך לציין את <AccessToken> או את <AuthorizationCode>.
סוג: מחרוזת

מאפיינים

מאפיין תיאור ברירת מחדל נוכחות
ref

משתנה של טוקן גישה. בדרך כלל, הערך מאוחזר ממשתנה זרימה. לדוגמה: request.header.token או request.queryparam.token.

 לא רלוונטי אופציונלי

אלמנט <AuthorizationCode>

מציין את המשתנה שבו נמצא קוד ההרשאה למחיקה. לדוגמה, אם קוד ההרשאה מצורף להודעת הבקשה כפרמטר של שאילתה בשם code, צריך לציין request.queryparam.code. אפשר להשתמש בכל משתנה תקין שמפנה לטוקן. או להעביר את מחרוזת האסימון המילולית (מקרה נדיר).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
ברירת מחדל: לא רלוונטי
נוכחות: צריך לציין את <AccessToken> או את <AuthorizationCode>.
סוג: מחרוזת

מאפיינים

מאפיין תיאור ברירת מחדל נוכחות
ref

משתנה של טוקן גישה. בדרך כלל, הערך מאוחזר ממשתנה זרימה. לדוגמה: request.header.code או request.queryparam.code.

 לא רלוונטי אופציונלי

‫<DisplayName> element

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

<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.

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