AccessEntity की नीति

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

क्या

आपने जो इकाई प्रोफ़ाइलें तय की हैं उन्हें Apigee Edge के डेटा स्टोर से हासिल करता है. यह नीति, प्रोफ़ाइल वैरिएबल में होनी चाहिए, जिसका नाम AccessEntity.{policy_name} फ़ॉर्मैट के अनुसार है. आपने लोगों तक पहुंचाया मुफ़्त में इन इकाइयों की प्रोफ़ाइल ऐक्सेस करने के लिए, AccessEntity का इस्तेमाल कर सकता है:

• ऐप्लिकेशन
• एपीआई प्रॉडक्ट
• कंपनी
• कंपनी डेवलपर
• ग्राहक कुँजी
• डेवलपर

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

इकाई की प्रोफ़ाइल का डेटा पाने के लिए, AccessEntity नीति का इस्तेमाल एक्सएमएल में उसे एक वैरिएबल में रखें. आप इकाई तय करके इकाई की पहचान कर सकते हैं टाइप और एक या एक से ज़्यादा ऐसे आइडेंटिफ़ायर होते हैं जिनसे पता चलता है कि आपको किस तरह की इकाई चाहिए. बाद में, किसी अन्य नीति के तहत, किसी दूसरी नीति की मदद से इकाई की प्रोफ़ाइल का डेटा वापस पाया जा सकता है, जैसे कि ExtractVariables की नीति या AssignMessage नीति का इस्तेमाल करें.

सैंपल

नीचे दिए गए सैंपल में बताया गया है कि AccessEntity का इस्तेमाल डेवलपर की जानकारी एक्सट्रैक्ट करने के लिए, ExtractVariables और AssignMessage नीतियां email करें और इसे एचटीटीपी हेडर में जोड़ें.

<AccessEntity name="GetDeveloperProfile">
  <!-- This is the type entity whose profile we need to pull from the Edge datastore. -->
  <EntityType  value="developer"/>
  <!-- We tell the policy to use the API key (presented as query parameter) to identify the developer. -->
  <EntityIdentifier ref="request.queryparam.apikey" type="consumerkey"/> 
</AccessEntity>

<ExtractVariables name="SetDeveloperProfile">
  <!-- The source element points to the variable populated by AccessEntity policy. 
  The format is <policy-type>.<policy-name>.
  In this case, the variable contains the whole developer profile. -->
  <Source>AccessEntity.GetDeveloperProfile</Source> 
  <VariablePrefix>developer</VariablePrefix>
  <XMLPayload>
    <Variable name="email" type="string"> 
        <!-- You parse elements from the developer profile using XPath. -->
      <XPath>/Developer/Email</XPath>
    </Variable>
  </XMLPayload>
</ExtractVariables>

<!-- We'll use this policy to return the variables set in the developer profile, 
just so that we can easily see them in the response. -->
<AssignMessage name="EchoVariables">
  <AssignTo createNew="false" type="response"></AssignTo>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <Set>
    <Headers>
      <Header name="X-Developer-email">{developer.email}</Header>
    </Headers>
  </Set>
</AssignMessage>

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

AccessEntity नीति का बुनियादी स्ट्रक्चर यह है:

<AccessEntity name="policy_name">
  <EntityType  value="entity_type"/>
  <EntityIdentifier ref="entity_identifier" type="identifier_type"/> 
  <SecondaryIdentifier ref="secondary_identifier" type="identifier_type"/>
</AccessEntity>

आपके पास एक ही तरह की कई इकाइयों को ऐक्सेस करने की सुविधा होती है. इसके लिए, उन्हें Identifiers एलिमेंट:

<AccessEntity name="name_of_the_policy">
  <EntityType  value="type_of_entity"/>
  <Identifiers>
    <Identifier>
      <EntityIdentifier ref="reference_to_entity_identifier" type*="identifier_type"/> 
      <SecondaryIdentifier ref="reference_to_secondary_entity_identifier" type="identifier_type"/><!-- optional -->
    </Identifier >
    <Identifier>
      <EntityIdentifier ref="reference_to_entity_identifier" type*="identifier_type"/> 
      <SecondaryIdentifier ref="reference_to_secondary_entity_identifier" type="identifier_type"/><!-- optional -->
    </Identifier >
  </Identifiers>
</AccessEntity>

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

<AccessEntity async="false" continueOnError="false" enabled="true" name="policy_name">

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

<DisplayName> एलिमेंट

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

<DisplayName>Policy Display Name</DisplayName>

<EntityIdentifier> एलिमेंट

पाने के लिए, EntityType में दिए गए टाइप की खास इकाई के बारे में बताता है.

<EntityIdentifier ref="value_variable" type="identifier_type"/> 

विशेषताएं

उदाहरण

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessEntity async="false" continueOnError="false" enabled="true" name="GetCompany">
    <DisplayName>GetCompanyProfile</DisplayName>
    <EntityType value="company"></EntityType>
    <EntityIdentifier ref="request.queryparam.apikey" type="consumerkey"/>
</AccessEntity>

<EntityType> एलिमेंट

डेटा स्टोर से पाने के लिए इकाई का प्रकार बताता है.

<EntityType  value="entity_type"/>

EntityIdentifier एलिमेंट का इस्तेमाल करके बताएं दिए गए टाइप की कौनसी इकाई आपको चाहिए. इकाई के टाइप की जानकारी के लिए, इकाई के टाइप और आइडेंटिफ़ायर देखें.

विशेषताएं

<SecondaryIdentifier> एलिमेंट

EntityIdentifier के साथ जोड़कर, चुने गए आइटम की पहचान करने के लिए वैल्यू तय करता है दिए गए EntityType का उदाहरण.

<SecondaryIdentifier ref="value_variable" type="identifier_type"/>

सिर्फ़ EntityIdentifier तय करते समय SecondaryIdentifier का इस्तेमाल करें इस बात की गारंटी नहीं देती कि आपको एक इकाई मिलेगी. सीमित करना देखें ज़्यादा जानकारी के लिए, सेकंडरी आइडेंटिफ़ायर वाले नतीजे.

एक से ज़्यादा SecondaryIdentifier एलिमेंट का इस्तेमाल नहीं किया जा सकता.

विशेषताएं

उदाहरण

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessEntity async="false" continueOnError="false" enabled="true" name="GetAPIProduct">
    <DisplayName>GetAPIProduct</DisplayName>
    <EntityType value="apiproduct"></EntityType>
    <EntityIdentifier ref="developer.app.name" type="appname"/> 
    <SecondaryIdentifier ref="developer.id" type="developerid"/> 
</AccessEntity>

इस्तेमाल की जानकारी

सेकंडरी आइडेंटिफ़ायर की मदद से नतीजों को सीमित करना

कुछ इकाइयों के लिए, हो सकता है कि एक आइडेंटिफ़ायर देना काफ़ी न हो, ताकि आप जिस इकाई के साथ काम कर सकें चाहते हैं. ऐसे मामलों में, ज़्यादा सटीक नतीजे पाने के लिए, सेकंडरी आइडेंटिफ़ायर का इस्तेमाल किया जा सकता है.

आपका पहला शायद बड़े पैमाने पर नीति का कॉन्फ़िगरेशन कुछ ऐसा दिख सकता है:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessEntity async="false" continueOnError="false" enabled="true" name="GetApp">
    <DisplayName>GetAppProfile</DisplayName>
    <EntityType value="apiproduct"></EntityType>
    <EntityIdentifier ref="request.queryparam.apikey" type="consumerkey"/>
</AccessEntity>

किसी ऐप्लिकेशन को एक से ज़्यादा एपीआई प्रॉडक्ट से जोड़ा जा सकता है. इसलिए, सिर्फ़ ऐप्लिकेशन आईडी का इस्तेमाल करने से हो सकता है कि वह एपीआई प्रॉडक्ट दिखाएं जो आपको चाहिए (आपको मेल खाने वाले कई प्रॉडक्ट में से सिर्फ़ पहला प्रॉडक्ट मिल सकता है).

इसके बजाय, ज़्यादा सटीक नतीजा पाने के लिए, SecondaryIdentifier का इस्तेमाल किया जा सकता है. इसके लिए उदाहरण के लिए, आपके फ़्लो में appname और developerid वैरिएबल हो सकते हैं क्योंकि ये OAuth 2.0 एक्सचेंज के दौरान डिफ़ॉल्ट रूप से अपने-आप भर जाते हैं. दोनों तरह की वैल्यू का इस्तेमाल किया जा सकता है AccessEntity नीति में मौजूद वैरिएबल, ताकि अनुरोध करने से जुड़ी प्रोफ़ाइल की जानकारी मिल सके है.

नीति के हिसाब से आपका खास कॉन्फ़िगरेशन, ऐसा दिख सकता है:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AccessEntity async="false" continueOnError="false" enabled="true" name="GetApp">
    <DisplayName>GetAppProfile</DisplayName>
    <EntityType value="apiproduct"></EntityType>
    <EntityIdentifier ref="developer.app.name" type="appname"/> 
    <SecondaryIdentifier ref="developer.id" type="developerid"/> 
</AccessEntity>

इस्तेमाल किए जा सकने वाले एलिमेंट के टाइप और आइडेंटिफ़ायर

AccessEntity में इस तरह के एलिमेंट और आइडेंटिफ़ायर इस्तेमाल किए जा सकते हैं.

इकाई प्रोफ़ाइल एक्सएमएल का उदाहरण

आपको {7/} के साथ जो इकाई प्रोफ़ाइल वैल्यू चाहिए उसे वापस पाने के लिए, आपको इसके बारे में कुछ जानने की ज़रूरत होगी प्रोफ़ाइल एक्सएमएल फ़ॉर्मैट में होना चाहिए. स्ट्रक्चर के उदाहरण के तौर पर, मैनेजमेंट एपीआई कॉल का इस्तेमाल करके एक्सएमएल डालें. ज़्यादा जानकारी के लिए, मैनेजमेंट एपीआई देखें संदर्भ देखें.

नीचे दिए गए सेक्शन में, एपीआई कॉल के लिए कोड के साथ-साथ कॉल से ली गई एक्सएमएल के उदाहरण दिए गए हैं.

ऐप्लिकेशन

$ curl -H "Accept:text/xml" -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/apps/{app_id} \
-u email:password

ऐप्लिकेशन डाउनलोड करें Edge management API रेफ़रंस में, ऐप्लिकेशन आईडी के हिसाब से व्यवस्थित करने का तरीका.

या:

$ curl -H "Accept:text/xml" -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/developers/{developer_email}/apps/{app_name} \
-u email:password

डाउनलोड करें Edge management API के रेफ़रंस में, डेवलपर ऐप्लिकेशन की जानकारी देखें.

प्रोफ़ाइल का नमूना:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<App name="thomas-app">
    <AccessType>read</AccessType>
    <ApiProducts/>
    <Credentials>
        <Credential>
            <Attributes/>
            <ConsumerKey>wrqOOOiPArFI0WRoB1gAJMRbOguekJ5w</ConsumerKey>
            <ConsumerSecret>WvOhDrJ8m6kzz7Ni</ConsumerSecret>
            <ApiProducts>
                <ApiProduct>
                    <Name>FreeProduct</Name>
                    <Status>approved</Status>
                </ApiProduct>
            </ApiProducts>
            <Scopes/>
            <Status>approved</Status>
        </Credential>
    </Credentials>
    <AppFamily>default</AppFamily>
    <AppId>ab308c13-bc99-4c50-8434-0e0ed1b86075</AppId>
    <Attributes>
        <Attribute>
            <Name>DisplayName</Name>
            <Value>Tom's Weather App</Value>
        </Attribute>
    </Attributes>
    <CallbackUrl>http://tom.app/login</CallbackUrl>
    <CreatedAt>1362502872727</CreatedAt>
    <CreatedBy>admin@apigee.com</CreatedBy>
    <DeveloperId>PFK8IwOeAOW01JKA</DeveloperId>
    <LastModifiedAt>1362502872727</LastModifiedAt>
    <LastModifiedBy>admin@apigee.com</LastModifiedBy>
    <Scopes/>
    <Status>approved</Status>
</App>

एपीआई प्रॉडक्ट

$ curl  -H "Accept:text/xml" -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/apiproducts/{apiproduct_name} \
-u email:password

एपीआई पाएं प्रॉडक्ट की जानकारी को ज़रूर देखें.

नमूना*, एपीआई प्रॉडक्ट नाम से दूसरा एपीआई संसाधन (यूआरआई) हासिल करता है weather_free:

/ApiProduct['@name=weather_free']/ApiResources/ApiResource[1]/text()

नमूना प्रोफ़ाइल को XML के रूप में लौटाया गया:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ApiProduct name="weather_free">
    <ApiResources>
        <ApiResource>/forecastrss, /reports</ApiResource>
    </ApiResources>
    <ApprovalType>auto</ApprovalType>
    <Attributes>
        <Attribute>
            <Name>description</Name>
            <Value>Introductory API Product</Value>
        </Attribute>
        <Attribute>
            <Name>developer.quota.interval</Name>
            <Value>1</Value>
        </Attribute>
        <Attribute>
            <Name>developer.quota.limit</Name>
            <Value>1</Value>
        </Attribute>
        <Attribute>
            <Name>developer.quota.timeunit</Name>
            <Value>minute</Value>
        </Attribute>
        <Attribute>
            <Name>servicePlan</Name>
            <Value>Introductory</Value>
        </Attribute>
    </Attributes>
    <CreatedAt>1355847839224</CreatedAt>
    <CreatedBy>andrew@apigee.com</CreatedBy>
    <Description>Free API Product</Description>
    <DisplayName>Free API Product</DisplayName>
    <Environments/>
    <LastModifiedAt>1355847839224</LastModifiedAt>
    <LastModifiedBy>andrew@apigee.com</LastModifiedBy>
    <Proxies/>
    <Scopes/>
</ApiProduct>

कंपनी

$ curl   -H "Accept:text/xml" -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies/{company_name} \
-u email:password

डाउनलोड करें Edge management API के रेफ़रंस में कंपनी की जानकारी.

प्रोफ़ाइल का नमूना:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Company name="theramin">
    <Apps/>
    <DisplayName>Theramin Corporation</DisplayName>
    <Organization>apigee-pm</Organization>
    <Status>active</Status>
    <Attributes>
        <Attribute>
            <Name>billing_code</Name>
            <Value>13648765</Value>
        </Attribute>
    </Attributes>
    <CreatedAt>1349208631291</CreatedAt>
    <CreatedBy>andrew@apigee.com</CreatedBy>
    <LastModifiedAt>1349208631291</LastModifiedAt>
    <LastModifiedBy>andrew@apigee.com</LastModifiedBy>
</Company>

कंपनी डेवलपर

$ curl -H "Accept:text/xml" -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies/{company_name}/developers/{developer_name} \
-u email:password

प्रोफ़ाइल का नमूना:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Developers>
    <Developer>
        <Email>ntesla@theramin.com</Email>
        <Role>developer</Role>
    </Developer>
</Developers>

ग्राहक कुँजी

$ curl -H "Accept:text/xml" -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} \
-u email:password

यह भी देखें Edge management API के रेफ़रंस में, डेवलपर ऐप्लिकेशन के बारे में खास जानकारी पाएं.

KML का उदाहरण:

/Credential/ApiProducts/ApiProduct[Name='weather_free']/Status/text()

प्रोफ़ाइल का नमूना:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Credential>
    <Attributes/>
    <ConsumerKey>XLotL3PRxNkUGXhGAFDPOr6fqtvAhuZe</ConsumerKey>
    <ConsumerSecret>iNUyEaOOh96KR3YL</ConsumerSecret>
    <ApiProducts>
        <ApiProduct>
            <Name>weather_free</Name>
            <Status>approved</Status>
        </ApiProduct>
    </ApiProducts>
    <Scopes/>
    <Status>approved</Status>
</Credential>

डेवलपर

$ curl -H "Accept:text/xml" -X GET \
https://api.enterprise.apigee.com/v1/o/{org_name}/developers/{developer_email} \
-u email:password

इसमें डेवलपर पाएं भी देखें Edge management API रेफ़रंस के तौर पर.

KML का उदाहरण:

/Developer/Attributes/Attribute[Name='my_custom_attribute']/Value/text()

/Developer/Email/text()

प्रोफ़ाइल का नमूना:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Developer>
    <Apps>
        <App>weatherappx</App>
        <App>weatherapp</App>
    </Apps>
    <Email>ntesla@theramin.com</Email>
    <DeveloperId>4Y4xd0KRZ1wmHJqu</DeveloperId>
    <FirstName>Nikola</FirstName>
    <LastName>Tesla</LastName>
    <UserName>theramin</UserName>
    <OrganizationName>apigee-pm</OrganizationName>
    <Status>active</Status>
    <Attributes>
        <Attribute>
            <Name>project_type</Name>
            <Value>public</Value>
        </Attribute>
    </Attributes>
    <CreatedAt>1349797040634</CreatedAt>
    <CreatedBy>rsaha@apigee.com</CreatedBy>
    <LastModifiedAt>1349797040634</LastModifiedAt>
    <LastModifiedBy>rsaha@apigee.com</LastModifiedBy>
</Developer>

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

जब AccessEntity नीति में दी गई इकाई की प्रोफ़ाइल फिर से मिल जाती है, तो एक्सएमएल के फ़ॉर्मैट में प्रोफ़ाइल ऑब्जेक्ट को मैसेज के कॉन्टेक्स्ट में वैरिएबल के तौर पर जोड़ा जाता है. इसे किसी भी अन्य प्लैटफ़ॉर्म की तरह ऐक्सेस किया जा सकता है वैरिएबल के नाम के रेफ़रंस के साथ. AccessEntity नीति के लिए, उपयोगकर्ता की ओर से दिया गया नाम को वैरिएबल नाम के वैरिएबल प्रीफ़िक्स के रूप में सेट किया गया है.

उदाहरण के लिए, अगर GetDeveloper नाम वाली AccessEntity नीति लागू की जाती है, तो तो एक्सएमएल-फ़ॉर्मैट की गई प्रोफ़ाइल AccessEntity.GetDeveloper. इसके बाद, XML- प्रारूपित प्रोफ़ाइल को उन एक्सट्रैक्ट वैरिएबल की नीति में बताया गया है जो AccessEntity.GetDeveloper के बारे में बताते हैं का स्रोत है.

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

इसी विषय से जुड़ी जानकारी के लिए, नीति से जुड़ी गड़बड़ियों के बारे में आपके लिए ज़रूरी जानकारी और गड़बड़ियों को ठीक करने के तरीके देखें.

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

कोई नहीं.

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

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

• ExtractVariables: ExtractVariables की नीति
• AssignMessage: AssignMessage नीति