यह Apigee Edge के दस्तावेज़ हैं.
पर जाएं
Apigee X दस्तावेज़. info
प्रॉक्सी और शेयरफ़्लो बंडल में, पीआईआई की मास्किंग मैनेज करना
सिंक करने की प्रोसेस के तहत, एपीआई हब कनेक्टर इंटिग्रेशन, आपके एपीआई प्रॉक्सी बंडल को एपीआई हब पर अपलोड करता है. इन बंडलों में, नीति कॉन्फ़िगरेशन के तहत संवेदनशील डेटा या व्यक्तिगत पहचान से जुड़ी जानकारी (पीआईआई) शामिल हो सकती है. इस सुविधा की मदद से, बंडल को एपीआई हब पर अपलोड करने से पहले, पहचाने गए व्यक्तिगत पहचान से जुड़ी जानकारी फ़ील्ड को मास्क किया जा सकता है.
मास्किंग का तरीका
पीआईआई की मास्किंग, XPath एक्सप्रेशन का इस्तेमाल करके की जाती है. इससे, XML फ़ॉर्मैट वाले प्रॉक्सी और शेयरफ़्लो बंडल में, नीति कॉन्फ़िगरेशन के खास एलिमेंट को टारगेट किया जाता है. हालांकि, बंडल में मौजूद अन्य सामान्य XML एलिमेंट को टारगेट नहीं किया जाता. इस सुविधा को दो हिस्सों में बांटा गया है:
डिफ़ॉल्ट मास्क
Apigee Edge में, XPath एक्सप्रेशन की पहले से तय की गई, इन-बिल्ट सूची शामिल होती है. इससे, सामान्य पीआईआई फ़ील्ड को अपने-आप टारगेट किया जाता है. अपलोड करने की प्रोसेस के दौरान, ये मास्क अपने-आप लागू हो जाते हैं.
डिफ़ॉल्ट मास्क की सूची:
| नीति का नाम | फ़ील्ड (या वैल्यू) का ब्यौरा | XPath एक्सप्रेशन |
|---|---|---|
AccessEntity |
इकाई का आइडेंटिफ़ायर | //AccessEntity/EntityIdentifier |
AccessEntity |
सेकंडरी आइडेंटिफ़ायर | //AccessEntity/SecondaryIdentifier |
BasicAuthentication |
यूज़र फ़ील्ड की वैल्यू | //BasicAuthentication/User |
BasicAuthentication |
पासवर्ड फ़ील्ड की वैल्यू | //BasicAuthentication/Password |
ConnectorCallout |
एक्सटेंशन को भेजने के लिए, JSON अनुरोध का मुख्य हिस्सा | //ConnectorCallout/Input |
FlowCallout |
फ़्लो कॉलआउट को पास किए गए पैरामीटर की वैल्यू | //FlowCallout/Parameter//FlowCallout/Parameters/Parameter |
HMAC |
एचएमएसी की गणना के लिए इस्तेमाल की गई सीक्रेट कुंजी | //HMAC/SecretKey |
HMAC |
साइन किया जाने वाला मैसेज कॉन्टेंट | //HMAC/Message |
HMAC |
एचएमएसी की पुष्टि करने की वैल्यू | //HMAC/VerificationValue |
JavaCallout |
पास की गई प्रॉपर्टी (संवेदनशील कॉन्फ़िगरेशन/डेटा) | //JavaCallout/Properties/Property |
Javascript |
इनलाइन सोर्स | //Javascript/Source |
Javascript |
प्रॉपर्टी की वैल्यू | //Javascript/Properties/Property |
GenerateJWS |
निजी कुंजी की वैल्यू | //GenerateJWS/PrivateKey/Value |
GenerateJWS |
निजी कुंजी का पासवर्ड | //GenerateJWS/PrivateKey/Password |
GenerateJWS |
निजी कुंजी का आईडी | //GenerateJWS/PrivateKey/Id |
GenerateJWS |
सीक्रेट कुंजी की वैल्यू | //GenerateJWS/SecretKey/Value |
GenerateJWS |
सीक्रेट कुंजी का आईडी | //GenerateJWS/SecretKey/Id |
VerifyJWS |
JWKS सार्वजनिक कुंजियां | //VerifyJWS/PublicKey/JWKS |
VerifyJWS |
सार्वजनिक कुंजी की वैल्यू | //VerifyJWS/PublicKey/Value |
VerifyJWS |
सीक्रेट कुंजी की वैल्यू | //VerifyJWS/SecretKey/Value |
GenerateJWT |
ज़रूरी हेडर की वैल्यू | //GenerateJWT/CriticalHeaders |
GenerateJWT |
JWT पर साइन करने के लिए इस्तेमाल की गई निजी कुंजी की वैल्यू | //GenerateJWT/PrivateKey/Value |
GenerateJWT |
निजी कुंजी का पासवर्ड | //GenerateJWT/PrivateKey/Password |
GenerateJWT |
निजी कुंजी का आईडी | //GenerateJWT/PrivateKey/Id |
GenerateJWT |
सीक्रेट कुंजी की वैल्यू | //GenerateJWT/SecretKey/Value |
GenerateJWT |
सीक्रेट कुंजी का आईडी | //GenerateJWT/SecretKey/Id |
VerifyJWT |
सार्वजनिक कुंजी | //VerifyJWT/PublicKey/Value |
VerifyJWT |
सीक्रेट कुंजी | //VerifyJWT/SecretKey/Value |
KeyValueMapOperations |
शुरुआती एंट्री और PUT कार्रवाइयों के लिए वैल्यू | //KeyValueMapOperations/InitialEntries/Entry/Value//KeyValueMapOperations/Put/Value |
Ldap |
उपयोगकर्ता नाम और पासवर्ड फ़ील्ड की वैल्यू | //Ldap/Authentication/UserName//Ldap/Authentication/Password |
OAuthV1 |
टोकन | //OAuthV1/Tokens/Token |
OAuthV1 |
ऐक्सेस टोकन | //OAuthV1/AccessToken |
OAuthV1 |
विशेषता की वैल्यू | //OAuthV1/Attributes/Attribute |
OAuthV1 |
वेरीफ़ायर कोड | //OAuthV1/VerifierCode |
OAuthV1 |
ऐप्लिकेशन इस्तेमाल करने वाले का आईडी | //OAuthV1/AppUserId |
OAuthV1 |
अनुरोध टोकन | //OAuthV1/RequestToken |
OAuthV2 |
विशेषता की वैल्यू | //OAuthV2/Attributes/Attribute |
GetOAuthV2Info |
ऐक्सेस टोकन | //GetOAuthV2Info/AccessToken |
GetOAuthV2Info |
ऑथराइज़ेशन कोड | //GetOAuthV2Info/AuthorizationCode |
GetOAuthV2Info |
क्लाइंट आईडी | //GetOAuthV2Info/ClientId |
GetOAuthV2Info |
रीफ़्रेश टोकन | //GetOAuthV2Info/RefreshToken |
RevokeOAuthV2 |
ऐप्लिकेशन आईडी | //RevokeOAuthV2/AppId |
RevokeOAuthV2 |
असली उपयोगकर्ता का आईडी | //RevokeOAuthV2/EndUserId |
SetOAuthV2Info |
ऐक्सेस टोकन | //SetOAuthV2Info/AccessToken |
SetOAuthV2Info |
विशेषता की वैल्यू | //SetOAuthV2Info/Attributes/Attribute |
DeleteOAuthV2Info |
ऐक्सेस टोकन की वैल्यू | //DeleteOAuthV2Info/AccessToken |
DeleteOAuthV2Info |
ऑथराइज़ेशन कोड की वैल्यू | //DeleteOAuthV2Info/AuthorizationCode |
StatisticsCollector |
आंकड़े की वैल्यू | //StatisticsCollector/Statistics/Statistic |
VerifyAPIKey |
हार्डकोड की गई एपीआई पासकोड | //VerifyAPIKey/APIKey |
कस्टम मास्क मैनेज करना
एक खास एपीआई की मदद से, XPath एक्सप्रेशन की पसंद के मुताबिक सूची सबमिट की जा सकती है. इससे, व्यक्तिगत पहचान से जुड़ी जानकारी के तौर पर पहचाने गए खास फ़ील्ड को मास्क किया जा सकता है. इससे, डेटा की निजता से जुड़ी आपकी खास ज़रूरतें पूरी होती हैं.
/v1/organizations/<var>ORG_NAME/uapim/proxymasks Edge मैनेजमेंट एपीआई एंडपॉइंट का इस्तेमाल करके, अपने संगठन के कस्टम व्यक्तिगत पहचान से जुड़ी जानकारी मास्क मैनेज किए जा सकते हैं. ये कार्रवाइयां करने के लिए, आपके पास orgadmin की भूमिका होनी चाहिए.
एपीआई, किसी संगठन के लिए proxymasks नाम की XPath की एक सूची पर काम करता है.
| तरीका | संसाधन | खास जानकारी | ब्यौरा |
|---|---|---|---|
GET |
/v1/organizations/ORG_NAME/uapim/proxymasks |
'proxymasks' XPath सूची पुनः पाना | इससे, दिए गए संगठन के लिए 'proxymasks' के XPath एक्सप्रेशन की पूरी सूची मिलती है. |
PUT |
/v1/organizations/ORG_NAME/uapim/proxymasks |
'proxymasks' XPath सूची बनाना या बदलना | अगर 'proxymasks' सूची मौजूद नहीं है, तो यह उसे बनाती है. अगर यह सूची मौजूद है, तो यह उसके कॉन्टेंट को पूरी तरह से बदल देती है. |
DELETE |
/v1/organizations/ORG_NAME/uapim/proxymasks |
'proxymasks' XPath सूची मिटाना | इससे, संगठन के लिए 'proxymasks' सूची में मौजूद सभी XPath मिट जाते हैं. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/append |
'proxymasks' सूची में XPath जोड़ना | इससे, मौजूदा 'proxymasks' सूची के आखिर में, एक या उससे ज़्यादा XPath स्ट्रिंग जुड़ जाती हैं. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems |
'proxymasks' सूची से खास XPath मिटाना | इससे, 'proxymasks' सूची से खास XPath स्ट्रिंग हट जाती हैं. यह पूरी तरह से मेल खाने वाली स्ट्रिंग से मैच करता है. |
XPath सूची से आइटम बनाने, बदलने, पाने, जोड़ने या मिटाने के सभी अनुरोधों और सफल जवाबों के लिए, यहां दिया गया JSON स्कीमा इस्तेमाल किया जाता है:
{ "xpaths": [ "//Path/To/Element" ] }
| फ़ील्ड | टाइप | ब्यौरा |
|---|---|---|
xpaths |
स्ट्रिंग का कलेक्शन | मास्क किए जाने वाले XPath एक्सप्रेशन स्ट्रिंग की सूची. यह फ़ील्ड भरना ज़रूरी है. |
1. कस्टम XPath सूची बनाना या बदलना (PUT)
PUT तरीके का इस्तेमाल करके, नई कस्टम सूची बनाई जा सकती है या किसी मौजूदा सूची के कॉन्टेंट को पूरी तरह से बदला जा सकता है. मौजूदा XPath ओवरराइट हो जाते हैं.
curl -X PUT https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }'
अपडेट पूरा होने पर, 201 Created या 200K रिस्पॉन्स दिखता है. इसके साथ, यह मैसेज दिखता है: Success response (201 Created or 200 OK)
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
2. कस्टम XPath सूची पुनः पाना (GET)
GET तरीके का इस्तेमाल करके, कस्टम XPath एक्सप्रेशन की मौजूदा सूची पुनः पाई जा सकती है.
curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
सूची पुनः पाने की प्रोसेस पूरी होने पर, 200K रिस्पॉन्स दिखता है. इसके साथ, यह मैसेज दिखता है:Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
3. सूची में XPath जोड़ना (POST append)
POST तरीके का इस्तेमाल करके, मौजूदा कॉन्टेंट को ओवरराइट किए बिना, मौजूदा सूची में एक या उससे ज़्यादा XPath एक्सप्रेशन जोड़े जा सकते हैं.
curl -X POST https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks/append \ -H "Authorization: Bearer OAUTH_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "xpaths": [ "//New/Appended/XPath" ] }'
सूची में XPath जोड़ने की प्रोसेस पूरी होने पर, 200K रिस्पॉन्स दिखता है. इसके साथ, यह मैसेज दिखता है: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. सूची से खास XPath मिटाना (POST deleteItems)
POST तरीके का इस्तेमाल करके, मौजूदा सूची से खास XPath एक्सप्रेशन हटाए जा सकते हैं. अनुरोध में, हटाए जाने वाली XPath स्ट्रिंग शामिल होनी चाहिए.
curl -X POST https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems \ -H "Authorization: Bearer OAUTH_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "xpaths": [ "//New/Appended/XPath" ] }'
XPath मिटाने की प्रोसेस पूरी होने पर, 200K रिस्पॉन्स दिखता है. इसके साथ, यह मैसेज दिखता है: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. कस्टम XPath की पूरी सूची मिटाना (DELETE)
DELETE तरीके का इस्तेमाल करके, कस्टम XPath की सूची को पूरी तरह से हटाया जा सकता है. इससे सिर्फ़ कस्टम मास्क हटेंगे. डिफ़ॉल्ट मास्क अब भी लागू रहेंगे.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
कस्टम XPath की सूची मिटाने की प्रोसेस पूरी होने पर, 204 No Content रिस्पॉन्स दिखता है. इसके साथ, यह मैसेज दिखता है: Success response (204 No Content):
HTTP/1.1 204 No Content
मास्क किए गए बंडल अपडेट करना
कस्टम पीआईआई मास्किंग कॉन्फ़िगरेशन में बदलाव करने पर, पहले अपलोड किए गए एपीआई प्रॉक्सी बंडल को, मास्क के पुराने कॉन्फ़िगरेशन के साथ फिर से प्रोसेस करना होगा. इसके लिए, मास्क के नए कॉन्फ़िगरेशन का इस्तेमाल करना होगा. बंडल को मास्क की नई सेटिंग के साथ अपडेट करने के लिए, कृपया ज़रूरी रीप्रोसेसिंग शुरू करने के लिए सहायता टिकट सबमिट करें.