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