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 पर सेट किया जाता है, तो नीति 'बंद' हो जाती है और लागू नहीं होती. भले ही, नीति किसी फ़्लो से जुड़ी हुई हो. सही ज़रूरी नहीं
नाम

नीति का अंदरूनी नाम. इस नाम को चरण एलिमेंट में बताया गया है, ताकि नीति को किसी फ़्लो से जोड़ा जा सके.

ध्यान दें: नाम में, नीचे दिए गए वर्ण इस्तेमाल किए जा सकते हैं: 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> एलिमेंट

उस वैरिएबल की पहचान करता है जहां मिटाया जाने वाला ऑथराइज़ेशन कोड मौजूद है. उदाहरण के लिए, अगर पुष्टि करने वाले कोड को "कोड" नाम के क्वेरी पैरामीटर के रूप में मैसेज का अनुरोध करने के लिए अटैच किया गया है, तो request.queryparam.code बताएं. आपके पास टोकन के रेफ़रंस वाले किसी भी मान्य वैरिएबल का इस्तेमाल करने का विकल्प है. इसके अलावा, लिटरल टोकन स्ट्रिंग को पास कर सकता है (बहुत कम केस).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
डिफ़ॉल्ट: लागू नहीं
मौजूदगी: इसमें <AccessToken> या <AuthorizationCode> ज़रूरी है.
टाइप: स्ट्रिंग

एट्रिब्यूट

एट्रिब्यूट ब्यौरा डिफ़ॉल्ट मौजूदगी
रेफ़रंस

ऐक्सेस टोकन वैरिएबल. आम तौर पर, फ़्लो वैरिएबल से लिया जाता है. उदाहरण के लिए: request.header.code या request.queryparam.code.

 लागू नहीं ज़रूरी नहीं

<DisplayName> एलिमेंट

आम भाषा का नाम, जो मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) के प्रॉक्सी एडिटर में नीति को लेबल करता है. अगर इसे मिटाया जाता है, तो नीति का नाम एट्रिब्यूट का इस्तेमाल किया जाता है.

<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"}}}

स्कीमा

हर तरह की नीति को एक्सएमएल स्कीमा (.xsd) से तय किया जाता है. रेफ़रंस के लिए, नीति के स्कीमा GitHub पर उपलब्ध हैं.

मिलते-जुलते विषय