מדיניות DeleteOAuthV2Info

מדיניות ניתנת להרחבה

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

המדיניות DeleteOAuthv2Info מוחקת את קוד ההרשאה או את אסימון הגישה שצוינו ב-OAuth V2.

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

דוגמאות

מחיקת טוקן גישה

בהמשך מופיעה דוגמה למדיניות שמשמשת למחיקת אסימון גישה מסוג 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 אופציונלי
name

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

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

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

אלמנט <AccessToken>

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

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

מאפיינים

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

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

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

אלמנט <AuthorizationCode>

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

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

מאפיינים

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

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

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

‫<DisplayName> element

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

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
ברירת מחדל: הערך של מאפיין name במדיניות.
נוכחות: אופציונלי
סוג: String

הפניה לשגיאה

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause
steps.oauth.v2.invalid_access_token 401 The access token sent to the policy is invalid.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 The authorization code sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Please see Oauth2.0 Access Token Verification throws "Invalid API call as no apiproduct match found" error for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

Example error response

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

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

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