מחיקת פרטי OAuthV2

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

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

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

false אופציונלי
continueOnError

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

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

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

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

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

רכיב <AccessToken>

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

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

מאפיינים

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

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

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

אלמנט <AuthorizationCode>

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

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

מאפיינים

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

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

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

<DisplayName> אלמנט

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

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

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