אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
ניהול מיסוך של מידע אישי בחבילות של שרת proxy ו-sharedflow
כחלק מתהליך הסנכרון, שילוב המחבר של API Hub מעלה את חבילות שרתי ה-proxy של ה-API אל API Hub. יכול להיות שהחבילות האלה יכילו מידע אישי רגיש או פרטים אישיים מזהים (PII), במסגרת הגדרות המדיניות. התכונה הזו מאפשרת להסתיר שדות של מידע אישי (PII) שזוהו לפני שהחבילות מועלות למרכז ה-API.
גישת הסימון
ההסתרה של פרטים אישיים מיושמת באמצעות ביטויי XPath שמטרתם היא אלמנטים ספציפיים בהגדרות המדיניות בחבילות של שרת ה-Proxy ושל Sharedflow בפורמט XML, אבל לא לאלמנטים כלליים אחרים של XML בחבילה. התכונה הזו מחולקת לשני חלקים:
מסכות ברירת מחדל
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 | //HMAC/SecretKey |
HMAC |
תוכן ההודעה שייחתם | //HMAC/Message |
HMAC |
ערך האימות של 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 |
Client-ID | //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 |
מפתח API שמוגדר בהארדקוד | //VerifyAPIKey/APIKey |
ניהול מסכות בהתאמה אישית
ממשק API ייעודי מאפשר לכם לשלוח רשימה מותאמת אישית של ביטויי XPath כדי להסתיר שדות ספציפיים שזיהיתם כ-PII, וכך לוודא שהצרכים הייחודיים שלכם בנוגע לפרטיות הנתונים יסופקו.
אתם יכולים לנהל את המסכות המותאמות אישית של פרטים אישיים מזהים (PII) בארגון באמצעות /v1/organizations/<var>ORG_NAME/uapim/proxymasks נקודת קצה ל-API של Edge Management. כדי לבצע את הפעולות האלה, צריכה להיות לכם הרשאת orgadmin.
ה-API פועל על רשימה אחת של נתיבי XPath בשם proxymasks עבור ארגון נתון.
| שיטה | משאב | סיכום | תיאור |
|---|---|---|---|
GET |
/v1/organizations/ORG_NAME/uapim/proxymasks |
אחזור רשימת ה-XPath של proxymasks | מקבל את הרשימה המלאה של ביטויי XPath עבור proxymasks עבור הארגון הנתון. |
PUT |
/v1/organizations/ORG_NAME/uapim/proxymasks |
יצירה או החלפה של רשימת ה-XPath proxymasks | יוצר את הרשימה proxymasks אם היא לא קיימת, או מחליף לחלוטין את התוכן שלה אם היא קיימת. |
DELETE |
/v1/organizations/ORG_NAME/uapim/proxymasks |
מחיקת רשימת ה-XPath proxymasks | מחיקת כל ה-XPaths ברשימה proxymasks של הארגון. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/append |
צירוף של XPaths לרשימה proxymasks | מוסיף מחרוזת XPath אחת או יותר לסוף הרשימה הקיימת של proxymasks. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems |
מחיקת XPath ספציפיים מהרשימה proxymasks | הסרה של מחרוזות XPath ספציפיות מהרשימה proxymasks. התאמה למחרוזות מדויקות. |
כל הבקשות והתשובות שמתקבלות אחרי יצירה, החלפה, אחזור, הוספה או מחיקה של פריטים מרשימת ה-XPath משתמשות בסכימת ה-JSON הבאה:
{ "xpaths": [ "//Path/To/Element" ] }
| שדה | סוג | תיאור |
|---|---|---|
xpaths |
מערך של מחרוזות | רשימה של מחרוזות של ביטויי XPath שיוסוו. חובה למלא את השדה הזה. |
1. יצירה או החלפה של רשימת XPath מותאמת אישית (PUT)
אפשר להשתמש בשיטה PUT כדי ליצור רשימה מותאמת אישית חדשה או להחליף לחלוטין את התוכן של רשימה קיימת. כל ה-XPaths הקיימים מוחלפים.
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)
כדי להוסיף ביטוי XPath אחד או יותר לרשימה הקיימת בלי לשכתב את התוכן הנוכחי, משתמשים בשיטה POST.
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. הבקשה חייבת לכלול את מחרוזות ה-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" ] }'
כשהמחיקה מסתיימת, מוצגת תגובה מסוג 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
עדכון חבילות מוסתרות
כשמשנים את ההגדרה של מיסוך פרטים אישיים בהתאמה אישית, צריך לעבד מחדש חבילות של שרתי proxy ל-API שהועלו בעבר עם הגדרת מיסוך ישנה יותר, באמצעות המיסוכים העדכניים. כדי לעדכן את החבילות עם הגדרות המיסוך העדכניות, צריך לשלוח כרטיס תמיכה כדי להתחיל את העיבוד מחדש הנדרש.