OAuth V2 नीति को रद्द करें

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

खास जानकारी

डेवलपर ऐप्लिकेशन आईडी या असली उपयोगकर्ता आईडी से जुड़े OAuth2 ऐक्सेस टोकन या दोनों को रद्द करता है.

OAuth 2.0 ऐक्सेस टोकन जनरेट करने के लिए, OAuthv2 नीति का इस्तेमाल करें. Apigee से जनरेट किए गए टोकन का फ़ॉर्मैट यह है:

{
  "issued_at" : "1421847736581",
  "application_name" : "a68d01f8-b15c-4be3-b800-ceae8c456f5a",
  "scope" : "READ",
  "status" : "approved",
  "api_product_list" : "[PremiumWeatherAPI]",
  "expires_in" : "3599", //--in seconds
  "developer.email" : "tesla@weathersample.com",
  "organization_id" : "0",
  "token_type" : "BearerToken",
  "client_id" : "k3nJyFJIA3p62DWOkLO6OJNi87GYXFmP",
  "access_token" : "7S22UqXGJDTuUADGzJzjXzXSaGJL",
  "organization_name" : "myorg",
  "refresh_token_expires_in" : "0", //--in seconds
  "refresh_count" : "0"
}

application_name एलिमेंट में, टोकन से जुड़ा डेवलपर ऐप्लिकेशन आईडी शामिल होता है.

डिफ़ॉल्ट रूप से, Apigee, टोकन में असली यूज़र आईडी को शामिल नहीं करता है. OAuthv2 नीति में <AppEndUser> एलिमेंट जोड़कर, असली उपयोगकर्ता आईडी को शामिल करने के लिए Apigee को कॉन्फ़िगर किया जा सकता है:

<OAuthV2 name="GenerateAccessTokenClient">
    <Operation>GenerateAccessTokenV/Operation>
    ...
    <AppEndUser>request.queryparam.app_enduser</AppEndUser>
</OAuthV2>

इस उदाहरण में, app_enduser नाम के क्वेरी पैरामीटर में, OAuthv2 नीति को असली उपयोगकर्ता आईडी पास करें. इसके बाद, असली यूज़र आईडी को app_enduser एलिमेंट में टोकन में शामिल किया जाता है:

{
 "issued_at" : "1421847736581",
 "application_name" : "a68d01f8-b15c-4be3-b800-ceae8c456f5a",
 "scope" : "READ",
 "app_enduser" : "6ZG094fgnjNf02EK",
 "status" : "approved",
 "api_product_list" : "[PremiumWeatherAPI]",
 "expires_in" : "3599", //--in seconds
 "developer.email" : "tesla@weathersample.com",
 "organization_id" : "0",
 "token_type" : "BearerToken",
 "client_id" : "k3nJyFJIA3p62DWOkLO6OJNi87GYXFmP",
 "access_token" : "7S22UqXGJDTuUADGzJzjXzXSaGJL",
 "organization_name" : "myorg",
 "refresh_token_expires_in" : "0", //--in seconds
 "refresh_count" : "0"
}

डेवलपर ऐप्लिकेशन आईडी के हिसाब से सहमति वापस लें

डेवलपर ऐप्लिकेशन आईडी से जुड़े OAuth2 ऐक्सेस टोकन निरस्त करें. Apigee से जनरेट किए गए सभी OAuth2 ऐक्सेस टोकन में, टोकन से जुड़े डेवलपर ऐप्लिकेशन का आईडी शामिल होता है. इसके बाद, उस ऐप्लिकेशन आईडी के आधार पर टोकन को रद्द किया जा सकता है.

• किसी खास डेवलपर के ऐप्लिकेशन आईडी की सूची पाने के लिए, Developer ऐप्लिकेशन API का इस्तेमाल करें.

• किसी ऐप्लिकेशन के बारे में जानकारी पाने के लिए, Developer ऐप्लिकेशन API का भी इस्तेमाल किया जा सकता है.

ऐप्लिकेशन के असली उपयोगकर्ता के आईडी के हिसाब से विज्ञापन वापस लेना

किसी खास ऐप के असली उपयोगकर्ता के आईडी से जुड़े OAuth2 ऐक्सेस टोकन को निरस्त करें. यह टोकन उस उपयोगकर्ता के आईडी से जुड़ा होता है जिसे टोकन जारी किए गए थे.

डिफ़ॉल्ट रूप से, OAuth ऐक्सेस टोकन में असली यूज़र आईडी के लिए कोई फ़ील्ड नहीं होता है. जैसा कि ऊपर दिखाया गया है, असली उपयोगकर्ता आईडी के ज़रिए OAuth 2.0 ऐक्सेस टोकन रद्द करने की सुविधा चालू करने के लिए, आपको OAuthv2 नीति को कॉन्फ़िगर करना होगा, ताकि टोकन में यूज़र आईडी को शामिल किया जा सके.

ऐप्लिकेशन का असली यूज़र आईडी पाने के लिए, Developer ऐप्लिकेशन API का इस्तेमाल करें.

सैंपल

नीचे दिए गए सैंपल, OAuth2 ऐक्सेस टोकन रद्द करने के लिए, OAuth V2 वापस लेने की नीति का इस्तेमाल किया जाता है.

<RevokeOAuthV2 continueOnError="false" enabled="true" name="MyRevokeTokenPolicy">
  <DisplayName>Revoke OAuth v2.0-1</DisplayName>
  <AppId ref="request.queryparam.app_id"></AppId>
</RevokeOAuthV2>

<RevokeOAuthV2 continueOnError="false" enabled="true" name="MyRevokeTokenPolicy">
  <DisplayName>Revoke OAuth v2.0-1</DisplayName>
  <AppId ref="request.queryparam.app_id"></AppId>
  <RevokeBeforeTimestamp>1561939200000</RevokeBeforeTimestamp>
</RevokeOAuthV2>

एलिमेंट का रेफ़रंस

एलिमेंट रेफ़रंस, “OAuthV2” नीति के एलिमेंट और एट्रिब्यूट के बारे में बताता है.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RevokeOAuthV2 continueOnError="false" enabled="true" name="GetOAuthV2Info-1">
  <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
  <AppId ref="variable"></AppId>
  <EndUserId ref="variable"></EndUserId>
  <RevokeBeforeTimestamp ref="variable"></RevokeBeforeTimestamp>
  <Cascade>false</Cascade>
</RevokeOAuthV2>

<AttributionOAuthV2> एट्रिब्यूट

<RevokeOAuthV2 continueOnError="false" enabled="true" name="Revoke-OAuth-v20-1">

इस टेबल में उन एट्रिब्यूट के बारे में बताया गया है जो नीति के सभी पैरंट एलिमेंट के लिए एक जैसे होते हैं:

<DisplayName> एलिमेंट

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

<DisplayName>Policy Display Name</DisplayName>

<AppId> एलिमेंट

रद्द किए जाने वाले टोकन का डेवलपर ऐप्लिकेशन आईडी बताता है. ऐसा वैरिएबल पास करें जिसमें ऐप्लिकेशन आईडी या लिटरल ऐप्लिकेशन आईडी शामिल हो.

<AppId>appIdString</AppId>

or:

<AppId ref="request.queryparam.app_id"></AppId>

<Cascade> एलिमेंट

अगर true और आपके पास पारंपरिक ओपेक ऐक्सेस टोकन है, तो <AppId> या <EndUserId> का मिलान होने पर, रीफ़्रेश टोकन और ऐक्सेस टोकन, दोनों को निरस्त कर दिया जाएगा. false होने पर, सिर्फ़ ऐक्सेस टोकन को निरस्त किया जाता है और रीफ़्रेश टोकन में कोई बदलाव नहीं किया जाता है. यही व्यवहार सिर्फ़ ओपेक ऐक्सेस टोकन पर लागू होता है.

<Cascade>false<Cascade>

<EndUserId> एलिमेंट

यह नीति, उस टोकन का ऐप्लिकेशन असली उपयोगकर्ता आईडी तय करती है जिसे रद्द करना है. ऐसे वैरिएबल को पास करें जिसमें यूज़र आईडी या लिटरल टोकन स्ट्रिंग हो.

<EndUserId>userIdString</EndUserId>

or:

<EndUserId ref="request.queryparam.access_token"></EndUserId>

<न्यूरिन्यूसे पहले टाइमस्टैंप> एलिमेंट

टाइमस्टैंप से पहले जारी किए गए टोकन रद्द करें. यह एलिमेंट <AppId> और <EndUserId> के साथ काम करता है, ताकि आप तय समय से पहले टोकन को निरस्त कर सकें. डिफ़ॉल्ट वैल्यू, नीति के लागू होने में लगने वाले समय को कहते हैं.

<RevokeBeforeTimestamp>timeStampString</RevokeBeforeTimestamp>

or:

<RevokeBeforeTimestamp ref="request.queryparam.revoke_since_timestamp"></RevokeBeforeTimestamp>

फ़्लो वैरिएबल

ConsentOAuthV2 नीति, फ़्लो वैरिएबल सेट नहीं करती है.

गड़बड़ी का रेफ़रंस

यह सेक्शन गड़बड़ी के कोड और दिखाए गए गड़बड़ी के मैसेज के बारे में बताता है. साथ ही, इस नीति के ट्रिगर होने पर Edge की मदद से सेट की गई गड़बड़ी के वैरिएबल के बारे में बताता है. यह जानकारी जानना ज़रूरी है कि क्या गड़बड़ियों को ठीक करने के लिए, गड़बड़ी से जुड़े नियम बनाए जा रहे हैं. ज़्यादा जानने के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी और गड़बड़ियों को ठीक करने के तरीके देखें.

रनटाइम से जुड़ी गड़बड़ियां

नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं. यहां गड़बड़ी के नाम ऐसी स्ट्रिंग दी गई हैं जिन्हें कोई गड़बड़ी होने पर, fault.name वैरिएबल को असाइन किया जाता है. ज़्यादा जानकारी के लिए, नीचे दिया गया 'फ़ॉल्ट वैरिएबल' सेक्शन देखें.

डिप्लॉयमेंट से जुड़ी गड़बड़ियां

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

गड़बड़ी वाले वैरिएबल

ये वैरिएबल तब सेट किए जाते हैं, जब यह नीति रनटाइम के दौरान कोई गड़बड़ी ट्रिगर करती है.

गड़बड़ी के जवाब का उदाहरण

{
   "fault":{
      "faultstring":"Timestamp is in the future.",
      "detail":{
         "errorcode":"steps.oauth.v2.InvalidFutureTimestamp"
      }
   }
}

गड़बड़ी के नियम का उदाहरण

<FaultRule name="RevokeOAuthV2 Faults">
    <Step>
        <Name>AM-InvalidTimestamp</Name>
    </Step>
    <Condition>(fault.name = "InvalidFutureTimestamp")</Condition>
</FaultRule>

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

• OAuthV2 नीति
• OAuth का होम पेज
• टोकन को पसंद के मुताबिक बनाना और ऑथराइज़ेशन कोड चुनना