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. אפשר להשתמש בכל משתנה תקין שמפנה לטוקן. או להעביר את מחרוזת האסימון המילולית (מקרה נדיר).

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

מאפיינים

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

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

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

‫<DisplayName> element

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

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

פלט

אם הפעולה בוצעה ללא שגיאות, המדיניות מחזירה סטטוס 200.

אם הפעולה נכשלת, המדיניות מחזירה 404 ופלט שדומה לזה (בהתאם לסוג הפריט שנמחק, אסימון גישה או קוד הרשאה):

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}

סכימה

כל סוג מדיניות מוגדר על ידי סכימת XML ‏ (.xsd). סכימות מדיניות זמינות ב-GitHub.

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