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">
एट्रिब्यूट ब्यौरा डिफ़ॉल्ट मौजूदगी
एक साथ काम नहीं करने वाली प्रोसेस

इसे true पर सेट करें, ताकि यह तय किया जा सके कि नीति को थ्रेड पूल में चलाया जाना चाहिए. यह थ्रेड पूल, अनुरोध/जवाब के फ़्लो को मैनेज करने वाले पूल से अलग होता है. डिफ़ॉल्ट रूप से, यह false पर सेट होता है.

इस सेटिंग का इस्तेमाल सिर्फ़ इंटरनल ऑप्टिमाइज़ेशन के लिए किया जाता है.

 गलत वैकल्पिक
continueOnError

ज़्यादातर नीतियों के उल्लंघन के मामले में, गड़बड़ी का मैसेज दिखता है. इस एट्रिब्यूट को true पर सेट करने से, फ़्लो के पूरा न होने पर भी फ़्लो चलता रहता है.

 गलत वैकल्पिक
चालू किया गया इस कुकी से यह तय होता है कि किसी नीति को लागू किया गया है या नहीं. false पर सेट करने का मतलब है कि नीति 'बंद है' और इसे लागू नहीं किया गया है. हालांकि, नीति अब भी फ़्लो से जुड़ी रहती है. सही वैकल्पिक
नाम

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

ध्यान दें: नाम में सिर्फ़ इन वर्णों का इस्तेमाल किया जा सकता है: 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"}}}

स्कीमा

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

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