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

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

Apigee Edge, नीतियों के सेट में OAuth 1.0a और OAuth 2 की सुविधाओं को इनकैप्सुलेट करता है. द लाइफ़ टोकन और सीक्रेट का साइकल मैनेजमेंट, जिसमें जेनरेशन, वैलिडेशन, और स्टोरेज शामिल है अपनी बैकएंड सेवाओं की ओर से, Apigee Edge से इसे पब्लिश करें.

इस दस्तावेज़ में उन फ़्लो वैरिएबल के बारे में बताया गया है जिन्हें OAuth नीतियों के मुताबिक तय किया गया है. वैरिएबल इनमें से कोई भी हो सकता है: का इस्तेमाल, OAuth फ़्लो के लिए पसंद के मुताबिक व्यवहार को लागू करने के लिए किया जाता है. OAuth के इस्तेमाल के बारे में जानने के लिए, OAuth का इस्तेमाल करें.

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

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

ऐक्सेस टोकन की नीति की पुष्टि करें
  • organization_name
  • organization_name
  • developer.id
  • developer.app.name
  • client_id
  • grant_type
  • token_type
  • access_token
  • accesstoken.{custom_attribute}
  • issued_at
  • expires_in
  • status
  • scope
  • apiproduct.name*
  • apiproduct.<custom_attribute_name>*

* एपीआई प्रॉडक्ट वैरिएबल

नीति का उदाहरण:

<OAuthV2 name="VerifyAccessToken">
    <Operation>VerifyAccessToken</Operation>
    <Scope>space-separated-scopes</Scope>*
    <AccessToken>flow.variable</AccessToken>*        
    <AccessTokenPrefix>Bearer</AccessTokenPrefix>*
</OAuthV2>

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

डिफ़ॉल्ट रूप से, ऐक्सेस टोकन, Authorization एचटीटीपी अनुरोध में पास किया जाना चाहिए हेडर.

उदाहरण के लिए:

"Authorization: Bearer {PlainText_AccessToken}"

किसी भी flow.variable को इस तरह पास किया जा सकता है:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

अगर वैकल्पिक फ़ील्ड तय नहीं किए गए हैं, तो वैल्यू, OAuth 2.0 के हिसाब से निकाली जाती हैं स्पेसिफ़िकेशन.
ऑथराइज़ेशन कोड की नीति जनरेट करें
सफलता के लिए सेट किए गए वैरिएबल:
  • oauthv2authcode.{policy_name}.code
  • oauthv2authcode.{policy_name}.redirect_uri
  • oauthv2authcode.{policy_name}.scope
  • oauthv2authcode.{policy_name}.client_id

नीति का उदाहरण:

<OAuthV2 name="GetAuthCode">
  <Operation>GenerateAuthorizationCode</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <ResponseType>flow.variable</ResponseType>*
  <ClientId>flow.variable</ClientId>*
  <RedirectUri>flow.variable</RedirectUri>*
  <Scope>flow.variable</Scope>*
  <State>flow.variable</State>*
  <Attributes>*   
    <Attribute name=”1” ref=”flow.variable”>value1</Attribute>
    <Attribute name=”2” ref=”flow.variable”>value2</Attribute>
  </Attributes>
</OAuthV2>

* ज़रूरी नहीं

किसी भी flow.variable को इस तरह पास किया जा सकता है:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

अगर वैकल्पिक फ़ील्ड तय नहीं किए गए हैं, तो वैल्यू, OAuth 2.0 के हिसाब से निकाली जाती हैं स्पेसिफ़िकेशन.

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

अगर दोनों के बारे में बताया गया है, तो फ़्लो वैरिएबल को प्राथमिकता दी जाती है.
अनुमति के टाइप का ऑथराइज़ेशन कोड, उपयोगकर्ता के क्रेडेंशियल, और क्लाइंट क्रेडेंशियल
सफलता के लिए सेट किए गए वैरिएबल:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.token_type
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.refresh_token

नीति का उदाहरण:

<OAuthV2 name="GenerateAccessToken">
  <Operation>GenerateAccessToken</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <SupportedGrantTypes>*
    <GrantType>authorization_code</GrantType>
    <GrantType>password</GrantType>
   <GrantType>client_credentials</GrantType>
  </SupportedGrantTypes>
  <GrantType>flow.variable</GrantType>* 
  <ClientId>flow.variable</ClientId>* 
  <RedirectUri>flow.variable</RedirectUri>* 
  <Scope>flow.variable</Scope>* 
  <AppEndUser>flow.variable</AppEndUser>* 
  <Code>flow.variable</Code>* 
  <UserName>flow.variable</UserName>* 
  <PassWord>flow.variable</PassWord>*
  <Attributes>*
    <Attribute name=”1” ref=”flow.variable”>value1</Attribute> 
    <Attribute name=”2” ref=”flow.variable”>value2</Attribute>  
  </Attributes>
</OAuthV2>

* ज़रूरी नहीं

किसी भी flow.variable को इस तरह पास किया जा सकता है:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

अगर वैकल्पिक फ़ील्ड तय नहीं किए गए हैं, तो वैल्यू, OAuth 2.0 के हिसाब से निकाली जाती हैं स्पेसिफ़िकेशन.

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

अगर दोनों के बारे में बताया गया है, तो फ़्लो वैरिएबल को प्राथमिकता दी जाती है.
इंप्लिसिट ग्रांट टाइप के लिए, ऐक्सेस टोकन की नीति जनरेट करें
सफलता के लिए सेट किए गए वैरिएबल:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.token_type
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.refresh_token

नीति का उदाहरण:

<OAuthV2 name="GenerateAccessToken">
  <Operation>GenerateAccessTokenImplicitGrant</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <ResponseType>flow.variable></ResponseType>*
  <ClientId>flow.variable></ClientId>*
  <RedirectUri>flow.variable></RedirectUri>*
  <Scope>flow.variable></Scope>*
  <State>flow.variable></State>*
  <AppEndUser>flow.variable</AppEndUser>*                                   
  <Attributes>*
    <Attribute name=”1” ref=”flow.variable”>value1</Attribute>
    <Attribute name=”2” ref=”flow.variable”>value2</Attribute>
  </Attributes>
</OAuthV2>

* ज़रूरी नहीं

किसी भी flow.variable को इस तरह पास किया जा सकता है:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

अगर वैकल्पिक फ़ील्ड तय नहीं किए गए हैं, तो वैल्यू, OAuth 2.0 के हिसाब से निकाली जाती हैं स्पेसिफ़िकेशन.

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

अगर दोनों के बारे में बताया गया है, तो फ़्लो वैरिएबल को प्राथमिकता दी जाती है.
ऐक्सेस टोकन से जुड़ी नीति रीफ़्रेश करें
सफलता के लिए सेट किए गए वैरिएबल:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.token_type
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.refresh_token

नीति का उदाहरण:

<OAuthV2 name="RefreshAccessToken">
  <Operation>RefreshAccessToken</Operation>
  <ExpiresIn>1000<ExpiresIn>
  <GrantType>flow.variable</GrantType>*
  <RefreshToken>flow.variable</RefreshToken>*
</OAuthV2>

* ज़रूरी नहीं

किसी भी flow.variable को इस तरह पास किया जा सकता है:

  • HTTP Header: request.header.{variable_name}
  • Query parameter: request.queryparam.{variable_name}
  • Form parameter: request.formparam.{variable_name}

अगर वैकल्पिक फ़ील्ड तय नहीं किए गए हैं, तो वैल्यू, OAuth 2.0 के हिसाब से निकाली जाती हैं स्पेसिफ़िकेशन.
क्लाइंट एट्रिब्यूट की नीति पाएं

नीति का उदाहरण:

<GetOAuthV2Info name="GetClientAttributes">
<ClientId ref="{variable_name}"/>
</GetOAuthV2Info>

नीति का उदाहरण:

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId>{client_id}</ClientId>
</GetOAuthV2Info>
ऐक्सेस टोकन के एट्रिब्यूट से जुड़ी नीति पाएं
सफलता के लिए सेट किए गए वैरिएबल:
  • oauthv2accesstoken.{policy_name}.access_token
  • oauthv2accesstoken.{policy_name}.scope
  • oauthv2accesstoken.{policy_name}.refresh_token
  • oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}
  • oauthv2accesstoken.{policy_name}.developer.id
  • oauthv2accesstoken.{policy_name}.developer.app.name
  • oauthv2accesstoken.{policy_name}.expires_in
  • oauthv2accesstoken.{policy_name}.status

नीति का उदाहरण:

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken ref="{variable_name}"/>
</GetOAuthV2Info>

नीति का उदाहरण:

<GetOAuthV2Info name="GetTokenAttributes">
<AccessToken>{access_token}</AccessToken>
</GetOAuthV2Info>
ऑथराइज़ेशन कोड के एट्रिब्यूट से जुड़ी नीति पाएं

नीति का उदाहरण:

<GetOAuthV2Info name="GetAuthCodeAttributes">
 <AuthorizationCode ref="{variable_name}"/>
</GetOAuthV2Info>

नीति का उदाहरण:

<GetOAuthV2Info name="GetAuthCodeAttributes">
    <AuthorizationCode>{authorization_code}</AuthorizationCode>
</GetOAuthV2Info>
रीफ़्रेश टोकन एट्रिब्यूट से जुड़ी नीति पाएं

नीति का उदाहरण:

<GetOAuthV2Info name="GetTokenAttributes">
  <RefreshToken ref="{variable_name}"/>
</GetOAuthV2Info>

नीति का उदाहरण:

<GetOAuthV2Info name="GetTokenAttributes">
    <RefreshToken>{refresh_token}</RefreshToken>
</GetOAuthV2Info>

OAuth 1.0a फ़्लो वैरिएबल

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

अनुरोध टोकन नीति जनरेट करें

नीति का उदाहरण:

<OAuthV1 name="GenerateRequestToken">
  <Operation>GenerateRequestToken</Operation>
</OAuthV1>

सफलता के लिए सेट किए गए वैरिएबल:

  • oauth_token
  • oauth_token_secret
  • oauth_callback_confirmed
  • oauth_response
  • oauth_consumer_key
  • oauth_consumer_secret

ऐक्सेस टोकन से जुड़ी नीति जनरेट करें

नीति का उदाहरण:

<OAuthV1 name="GenerateAccessToken">
  <Operation>GenerateAccessToken</Operation>
</OAuthV1>

सफलता के लिए सेट किए गए वैरिएबल:

  • oauth_token
  • oauth_token_secret
  • oauth_response
  • oauth_consumer_key
  • oauth_consumer_secret

ऐक्सेस टोकन की पुष्टि करना नीति

नीति का उदाहरण:

<OAuthV1 name="VerifyAccessToken">
  <Operation>VerifyAccessToken</Operation>
</OAuthV1>

सफलता के लिए सेट किए गए वैरिएबल:

  • oauth_token
  • oauth_token_secret
  • oauth_response
  • oauth_consumer_key
  • oauth_consumer_secret

एपीआई पासकोड से जुड़ी नीति की पुष्टि करें

नीति का उदाहरण:

<GetOAuthV1Info name="VerifyApiKey">
  <OAuthConfig>{config_name}</OAuthConfig>*
  <APIKey ref="{variable_name}" />
</GetOAuthV1Info>

* ज़रूरी नहीं

सफलता के लिए सेट किए गए वैरिएबल:

  • oauth_consumer_key
  • oauth_consumer_secret

उपभोक्ता नीति की पुष्टि करें

नीति का उदाहरण:

<GetOAuthV1Info name="VerifyConsumer">
  <OAuthConfig>{config_name}</OAuthConfig>*
  <ConsumerKey ref="{variable_name}" />
</GetOAuthV1Info>

* ज़रूरी नहीं

सफलता के लिए सेट किए गए वैरिएबल:

  • oauth_consumer_key
  • oauth_consumer_secret

टोकन नीति की पुष्टि करें

नीति का उदाहरण:

<GetOAuthV1Info name="VerifyToken">
  <OAuthConfig>{config_name}</OAuthConfig>*
  <RequestToken ref="{variable_name}" />
</GetOAuthV1Info>

* ज़रूरी नहीं

सफलता के लिए सेट किए गए वैरिएबल:

  • oauth_token
  • oauth_token_secret