आपको 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">
एट्रिब्यूट | ब्यौरा | डिफ़ॉल्ट | मौजूदगी |
---|---|---|---|
एक साथ काम नहीं करने वाली प्रोसेस |
इस सेटिंग का इस्तेमाल सिर्फ़ अंदरूनी ऑप्टिमाइज़ेशन के लिए किया जाता है. |
गलत | वैकल्पिक |
continueOnError |
कोई गड़बड़ी होने पर, ज़्यादातर नीतियों से गड़बड़ी दिखने की संभावना होती है. इसे सेट करके
एट्रिब्यूट की वैल्यू |
गलत | वैकल्पिक |
चालू किया गया | इससे यह तय होता है कि कोई नीति लागू है या नहीं. अगर false पर सेट की जाती है, तो
नीति 'बंद' है, और लागू नहीं की जाती (भले ही नीति
फ़्लो). |
सही | वैकल्पिक |
नाम |
नीति का अंदरूनी नाम. अटैच करने के लिए, स्टेप एलिमेंट में यह नाम बताया गया है नीति का उल्लंघन नहीं करता. ध्यान दें: नाम में इस्तेमाल किए जा सकने वाले वर्ण इन तक सीमित हैं:
|
लागू नहीं | ज़रूरी है |
<AccessToken> एलिमेंट
उस वैरिएबल की पहचान करता है जहां मिटाया जाने वाला ऐक्सेस टोकन मौजूद है. उदाहरण के लिए, अगर
ऐक्सेस टोकन, "access_token" नाम के क्वेरी पैरामीटर के तौर पर मैसेज का अनुरोध करने के लिए जुड़ा हुआ है.
request.queryparam.access_token
. किसी भी ऐसे मान्य वैरिएबल का इस्तेमाल किया जा सकता है जो
टोकन. इसके अलावा, लिटरल टोकन स्ट्रिंग (बहुत कम इस्तेमाल होने वाला केस) में पास किया जा सकता है.
<AccessToken ref="request.queryparam.access_token"></AccessToken>
डिफ़ॉल्ट: | लागू नहीं |
मौजूदगी: | <AccessToken> या <AuthorizationCode>
आवश्यक. |
टाइप: | स्ट्रिंग |
विशेषताएं
एट्रिब्यूट | ब्यौरा | डिफ़ॉल्ट | मौजूदगी |
---|---|---|---|
संदर्भ |
ऐक्सेस टोकन वैरिएबल. आम तौर पर, किसी फ़्लो वैरिएबल से लिया जाता है. इसके लिए
उदाहरण: |
लागू नहीं | वैकल्पिक |
<AuthorizationCode> एलिमेंट
उस वैरिएबल की पहचान करता है जहां मिटाया जाने वाला ऑथराइज़ेशन कोड मौजूद है. उदाहरण के लिए, अगर
ऑथराइज़ेशन कोड को "कोड" नाम के क्वेरी पैरामीटर के रूप में मैसेज का अनुरोध करने के लिए जोड़ा गया है,
request.queryparam.code
. किसी भी ऐसे मान्य वैरिएबल का इस्तेमाल किया जा सकता है जिससे टोकन का रेफ़रंस मिलता हो.
इसके अलावा, लिटरल टोकन स्ट्रिंग (बहुत कम इस्तेमाल होने वाला केस) में पास किया जा सकता है.
<AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
डिफ़ॉल्ट: | लागू नहीं |
मौजूदगी: | <AccessToken> या <AuthorizationCode>
आवश्यक. |
टाइप: | स्ट्रिंग |
विशेषताएं
एट्रिब्यूट | ब्यौरा | डिफ़ॉल्ट | मौजूदगी |
---|---|---|---|
संदर्भ |
ऐक्सेस टोकन वैरिएबल. आम तौर पर, किसी फ़्लो वैरिएबल से लिया जाता है. इसके लिए
उदाहरण: |
लागू नहीं | वैकल्पिक |
<DisplayName> एलिमेंट
यह ऐसा नाम होता है जो आम तौर पर इस्तेमाल होने वाले भाषा में होता है और मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) के प्रॉक्सी एडिटर में नीति को लेबल करता है. अगर इसे छोड़ दिया जाता है, तो नीति का नाम एट्रिब्यूट का इस्तेमाल किया जाता है.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
डिफ़ॉल्ट: | नीति के name एट्रिब्यूट की वैल्यू. |
मौजूदगी: | वैकल्पिक |
टाइप: | स्ट्रिंग |
गड़बड़ी का रेफ़रंस
इस सेक्शन में, गड़बड़ी के कोड और गड़बड़ी के मैसेज के बारे में बताया गया है. साथ ही, इन गड़बड़ियों के वैरिएबल के बारे में भी बताया गया है, जो Edge की मदद से सेट किए जाते हैं. यह जानकारी जानना ज़रूरी है कि क्या आप गड़बड़ियों को ठीक करता है. ज़्यादा जानने के लिए, आपके लिए ज़रूरी जानकारी देखें नीति से जुड़ी गड़बड़ियों और हैंडलिंग के बारे में जानकारी गलतियां.
रनटाइम की गड़बड़ियां
नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं.
गड़बड़ी कोड | एचटीटीपी कोड स्थिति | वजह |
---|---|---|
steps.oauth.v2.invalid_access_token |
401 | नीति को भेजा गया ऐक्सेस टोकन अमान्य है. |
steps.oauth.v2.invalid_request-authorization_code_invalid |
401 | नीति को भेजा गया ऑथराइज़ेशन कोड अमान्य है. |
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound |
401 | कृपया देखें यह Apigee कम्यूनिटी पोस्ट पढ़ें. |
डिप्लॉयमेंट से जुड़ी गड़बड़ियां
डिप्लॉयमेंट की गड़बड़ियों के बारे में जानकारी के लिए, यूज़र इंटरफ़ेस (यूआई) में रिपोर्ट किया गया मैसेज देखें.
गड़बड़ी के वैरिएबल
ये वैरिएबल तब सेट किए जाते हैं, जब यह नीति रनटाइम के दौरान कोई गड़बड़ी ट्रिगर करती है.
वैरिएबल | कहां | उदाहरण |
---|---|---|
fault.name="fault_name" |
fault_name गड़बड़ी का नाम है, जैसा कि ऊपर रनटाइम में गड़बड़ियां टेबल में बताया गया है. गड़बड़ी का नाम, गड़बड़ी के कोड का आखिरी हिस्सा होता है. | fault.name = "invalid_access_token" |
oauthV2.policy_name.failed |
policy_name, उपयोगकर्ता की ओर से बताया गया उस नीति का नाम है जिसमें गड़बड़ी हुई है. | oauthV2.DeleteTokenInfo.failed = true |
oauthV2.policy_name.fault.name |
policy_name, उपयोगकर्ता की ओर से बताया गया उस नीति का नाम है जिसमें गड़बड़ी हुई है. | oauthV2.DeleteTokenInfo.fault.name = invalid_access_token |
oauthv2.policy_name.fault.cause |
policy_name, उपयोगकर्ता की ओर से बताया गया उस नीति का नाम है जिसमें गड़बड़ी हुई है. | oauthV2.DeleteTokenInfo.cause = Invalid Access Token |
गड़बड़ी के रिस्पॉन्स का उदाहरण
{ "fault": { "faultstring": "Invalid Access Token", "detail": { "errorcode": "keymanagement.service.invalid_access_token" } } }
गड़बड़ी के नियम का उदाहरण
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults"> <Step> <Name>AM-InvalidTokenResponse</Name> </Step> <Condition>(fault.name = "invalid_access_token")</Condition> </FaultRule>
स्कीमा
हर तरह की नीति को एक्सएमएल स्कीमा (.xsd
) से तय किया जाता है. रेफ़रंस के लिए, नीति के स्कीमा
GitHub पर उपलब्ध हैं.