מוצג המסמך של 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 של המדיניות. |
נוכחות: | אופציונלי |
סוג: | מחרוזת |
התייחסות לשגיאות
This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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 this Apigee Community post 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.