درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
مدیریت پوشاندن اطلاعات شناسایی شخصی در دستههای پراکسی و جریان مشترک
بهعنوان بخشی از فرایند همگامسازی، یکپارچهسازی اتصالدهنده مرکز API دستههای پراکسی API شما را در مرکز API بارگذاری میکند. این دستهها ممکن است حاوی دادههای حساس یا اطلاعات شناساننده شخصی (PII) در پیکربندیهای خطمشی باشند. این ویژگی به شما امکان میدهد فیلدهای «اطلاعات شناسایی شخصی» شناساییشده را قبلاز بارگذاری دستهها در مرکز API بپوشانید.
رویکرد پوشاندن
پوشش PII بااستفاده از عبارات XPath برای هدفیابی عناصر خاص در پیکربندیهای خطمشی در بستههای پراکسی و 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 |
شناسه کارخواه | //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 |
مدیریت کردن پوششهای سفارشی
یک API اختصاصی به شما امکان میدهد فهرست سفارشیشدهای از عبارات XPath را ارسال کنید تا فیلدهای خاصی را که بهعنوان «اطلاعات شناسایی شخصی» مشخص کردهاید بپوشانید و از این طریق مطمئن شوید که نیازهای منحصربهفرد شما در زمینه حریم خصوصی دادهها برآورده میشود.
میتوانید پوششهای سفارشی اطلاعات شخصی قابل شناسایی سازمانتان را بااستفاده از /v1/organizations/<var>ORG_NAME/uapim/proxymasks نقطه پایانی API مدیریت Edge مدیریت کنید. برای انجام این عملیات باید نقش orgadmin را داشته باشید.
این «میانای برنامهسازی کاربردی» روی یک فهرست واحد از XPaths به نام 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 |
حذف کردن XPaths خاص از فهرست «proxymasks» | رشتههای XPath خاصی را از فهرست «proxymasks» برمیدارد. با رشتههای دقیق مطابقت دارد. |
همه درخواستها و پاسخهای موفق برای ایجاد، جایگزینی، دریافت، پیوست کردن، یا حذف کردن عناصر از فهرست XPath از طرحواره JSON زیر استفاده میکنند:
{ "xpaths": [ "//Path/To/Element" ] }
| فیلد | نوع | شرح |
|---|---|---|
xpaths |
آرایه رشتهها | فهرستی از رشتههای عبارت XPath که باید پوشانده شوند. این فیلد ضروری است. |
۱. ایجاد یا جایگزین کردن فهرست سفارشی XPath (قرار دادن)
از روش 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" ] }
۲. بازیابی فهرست سفارشی XPath (دریافت)
از روش 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" ] }
۳. افزودن XPaths به فهرست (افزودن POST)
از روش 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" ] }
۴. حذف کردن XPaths خاص از فهرست (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" ] }'
وقتی حذف کامل شد، پاسخ 200K با پیام زیر نمایش داده میشود: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
۵. حذف کل فهرست سفارشی XPath (حذف)
از روش DELETE برای برداشتن کامل فهرست سفارشی XPath استفاده کنید. با این کار، فقط پوششهای سفارشی برداشته میشود؛ پوششهای پیشفرض همچنان اعمال خواهد شد.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
وقتی حذف کامل شد، پاسخ «204 بدون محتوا» با پیام زیر نمایش داده میشود: Success response (204 No Content):
HTTP/1.1 204 No Content
درحال بهروزرسانی دستههای پوشاندهشده
وقتی پیکربندی پوششدهی اطلاعات شخصی قابلشناسایی سفارشیتان را اصلاح میکنید، دستههای پراکسی API که قبلاً با پیکربندی پوششدهی قدیمیتر بارگذاری شدهاند باید با جدیدترین پوششها دوباره پردازش شوند. برای بهروزرسانی دستهها با جدیدترین تنظیمات پوشش، لطفاً درخواست پشتیبانی ثبت کنید تا پردازش مجدد لازم آغاز شود.