आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
प्रॉक्सी और शेयर किए गए फ़्लो बंडल में, पीआईआई को मास्क करने की सुविधा मैनेज करना
सिंक करने की प्रोसेस के तहत, API हब कनेक्टर इंटिग्रेशन, आपके एपीआई प्रॉक्सी बंडल को API हब पर अपलोड करता है. इन बंडलों में नीति के कॉन्फ़िगरेशन के तहत, संवेदनशील डेटा या व्यक्तिगत पहचान से जुड़ी जानकारी (पीआईआई) शामिल हो सकती है. इस सुविधा की मदद से, एपीआई हब पर बंडल अपलोड करने से पहले, पहचान की जानकारी (पीआईआई) वाले फ़ील्ड को मास्क किया जा सकता है.
मास्क करने का तरीका
पीआईआई मास्किंग को XPath एक्सप्रेशन का इस्तेमाल करके लागू किया जाता है. इससे, एक्सएमएल फ़ॉर्मैट वाले प्रॉक्सी और शेयरफ़्लो बंडलों में नीति कॉन्फ़िगरेशन के अंदर मौजूद खास एलिमेंट को टारगेट किया जाता है. हालांकि, बंडल में मौजूद अन्य सामान्य एक्सएमएल एलिमेंट को टारगेट नहीं किया जाता. इस सुविधा को दो हिस्सों में बांटा गया है:
डिफ़ॉल्ट मास्क
Apigee Edge में, XPath एक्सप्रेशन की पहले से तय की गई, इन-बिल्ट सूची शामिल होती है. यह सूची, सामान्य PII फ़ील्ड को अपने-आप टारगेट करती है. अपलोड करने की प्रोसेस के दौरान, ये मास्क अपने-आप लागू हो जाते हैं.
डिफ़ॉल्ट मास्क की सूची:
| नीति का नाम | फ़ील्ड (या वैल्यू) की जानकारी | 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 management API एंडपॉइंट का इस्तेमाल करके, अपने संगठन के कस्टम पीआईआई मास्क मैनेज किए जा सकते हैं. ये कार्रवाइयां करने के लिए, आपके पास orgadmin की भूमिका होनी चाहिए.
एपीआई, किसी संगठन के लिए proxymasks नाम वाले XPaths की एक सूची पर काम करता है.
| तरीका | संसाधन | खास जानकारी | ब्यौरा |
|---|---|---|---|
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)
कस्टम XPath एक्सप्रेशन की मौजूदा सूची को वापस पाने के लिए, GET तरीके का इस्तेमाल करें.
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" ] }'
डेटा जोड़ने की प्रोसेस पूरी होने पर, 200K रिस्पॉन्स दिखता है. इसमें यह मैसेज होता है: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. सूची से कुछ खास XPath मिटाना (POST deleteItems)
मौजूदा सूची से कुछ XPath एक्सप्रेशन हटाने के लिए, POST तरीके का इस्तेमाल करें. अनुरोध में, हटाए जाने वाले एक्सपाथ स्ट्रिंग शामिल होने चाहिए.
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" ] }'
मिटाने की प्रोसेस पूरी होने के बाद, 200K रिस्पॉन्स दिखता है. इसमें यह मैसेज होता है: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. पूरी कस्टम XPath सूची मिटाएं (DELETE)
कस्टम XPath सूची को हमेशा के लिए हटाने के लिए, DELETE तरीके का इस्तेमाल करें. इससे सिर्फ़ कस्टम मास्क हटेंगे. डिफ़ॉल्ट मास्क अब भी लागू रहेंगे.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
मिटाने की प्रोसेस पूरी होने के बाद, 204 No Content जवाब दिखता है. इसमें यह मैसेज होता है: Success response (204 No Content):
HTTP/1.1 204 No Content
मास्क किए गए बंडल अपडेट किए जा रहे हैं
कस्टम पीआईआई मास्किंग कॉन्फ़िगरेशन में बदलाव करने पर, एपीआई प्रॉक्सी बंडलों को फिर से प्रोसेस करना होगा. इन बंडलों को पहले, मास्किंग के पुराने कॉन्फ़िगरेशन के साथ अपलोड किया गया था. अब इन्हें मास्किंग के नए कॉन्फ़िगरेशन के साथ प्रोसेस करना होगा. मास्किंग की नई सेटिंग के साथ बंडल अपडेट करने के लिए, कृपया सहायता टिकट सबमिट करें, ताकि ज़रूरी रीप्रोसेसिंग शुरू की जा सके.