Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Proxy ve sharedflow paketlerinde kimliği tanımlayabilecek bilgilerin maskelenmesini yönetme
Senkronizasyon sürecinin bir parçası olarak, API Hub bağlayıcı entegrasyonu API proxy paketlerinizi API Hub'a yükler. Bu paketler, politika yapılandırmaları içinde hassas veriler veya kimliği tanımlayabilecek bilgiler (PII) içerebilir. Bu özellik, paketler API merkezine yüklenmeden önce tanımlanan kimlik bilgisi alanlarını maskelemenize olanak tanır.
Maskeleme yaklaşımı
Kişisel olarak tanımlanabilir bilgilerin maskelenmesi, XML biçimli proxy ve sharedflow paketlerindeki politika yapılandırmalarında belirli öğeleri hedeflemek için XPath ifadeleri kullanılarak uygulanır ancak paket içindeki diğer genel XML öğelerine uygulanmaz. Bu özellik iki bölüme ayrılmıştır:
Varsayılan maskeler
Apigee Edge, yaygın kimliği tanımlayabilecek bilgiler alanlarını otomatik olarak hedefleyen, önceden tanımlanmış ve yerleşik bir XPath ifadeleri listesi içerir. Bu maskeler, yükleme işlemi sırasında otomatik olarak uygulanır.
Varsayılan maskelerin listesi:
| Politika Adı | Alan (veya Değer) Açıklaması | XPath İfadeleri |
|---|---|---|
AccessEntity |
Varlık tanımlayıcısı | //AccessEntity/EntityIdentifier |
AccessEntity |
İkincil tanımlayıcı | //AccessEntity/SecondaryIdentifier |
BasicAuthentication |
Kullanıcı alanı değeri | //BasicAuthentication/User |
BasicAuthentication |
Şifre alanı değeri | //BasicAuthentication/Password |
ConnectorCallout |
Uzantıya gönderilecek JSON istek gövdesi | //ConnectorCallout/Input |
FlowCallout |
Akış çağrısına iletilen parametrelerin değerleri | //FlowCallout/Parameter//FlowCallout/Parameters/Parameter |
HMAC |
HMAC hesaplaması için kullanılan gizli anahtar | //HMAC/SecretKey |
HMAC |
İmzalanacak mesaj içeriği | //HMAC/Message |
HMAC |
HMAC doğrulama değeri | //HMAC/VerificationValue |
JavaCallout |
Geçirilen özellikler (hassas yapılandırma/veriler) | //JavaCallout/Properties/Property |
Javascript |
Satır içi kaynak | //Javascript/Source |
Javascript |
Tesis değerleri | //Javascript/Properties/Property |
GenerateJWS |
Özel anahtar değeri | //GenerateJWS/PrivateKey/Value |
GenerateJWS |
Özel anahtar şifresi | //GenerateJWS/PrivateKey/Password |
GenerateJWS |
Özel anahtar kimliği | //GenerateJWS/PrivateKey/Id |
GenerateJWS |
Gizli anahtar değeri | //GenerateJWS/SecretKey/Value |
GenerateJWS |
Gizli anahtar kimliği | //GenerateJWS/SecretKey/Id |
VerifyJWS |
JWKS ortak anahtarları | //VerifyJWS/PublicKey/JWKS |
VerifyJWS |
Ortak anahtar değeri | //VerifyJWS/PublicKey/Value |
VerifyJWS |
Gizli anahtar değeri | //VerifyJWS/SecretKey/Value |
GenerateJWT |
Kritik üstbilgi değerleri | //GenerateJWT/CriticalHeaders |
GenerateJWT |
JWT'yi imzalamak için kullanılan özel anahtar değeri | //GenerateJWT/PrivateKey/Value |
GenerateJWT |
Özel anahtar şifresi | //GenerateJWT/PrivateKey/Password |
GenerateJWT |
Özel anahtar kimliği | //GenerateJWT/PrivateKey/Id |
GenerateJWT |
Gizli anahtar değeri | //GenerateJWT/SecretKey/Value |
GenerateJWT |
Gizli anahtar kimliği | //GenerateJWT/SecretKey/Id |
VerifyJWT |
Ortak anahtar | //VerifyJWT/PublicKey/Value |
VerifyJWT |
Gizli anahtar | //VerifyJWT/SecretKey/Value |
KeyValueMapOperations |
İlk girişler ve PUT işlemleri için değerler | //KeyValueMapOperations/InitialEntries/Entry/Value//KeyValueMapOperations/Put/Value |
Ldap |
Kullanıcı adı ve şifre alanı değerleri | //Ldap/Authentication/UserName//Ldap/Authentication/Password |
OAuthV1 |
Token'lar | //OAuthV1/Tokens/Token |
OAuthV1 |
Erişim jetonu | //OAuthV1/AccessToken |
OAuthV1 |
Özellik değerleri | //OAuthV1/Attributes/Attribute |
OAuthV1 |
Doğrulayıcı kodu | //OAuthV1/VerifierCode |
OAuthV1 |
Uygulama kullanıcı kimliği | //OAuthV1/AppUserId |
OAuthV1 |
İstek jetonu | //OAuthV1/RequestToken |
OAuthV2 |
Özellik değerleri | //OAuthV2/Attributes/Attribute |
GetOAuthV2Info |
Erişim jetonu | //GetOAuthV2Info/AccessToken |
GetOAuthV2Info |
Yetkilendirme kodu | //GetOAuthV2Info/AuthorizationCode |
GetOAuthV2Info |
Müşteri Kimliği | //GetOAuthV2Info/ClientId |
GetOAuthV2Info |
Yenileme jetonu | //GetOAuthV2Info/RefreshToken |
RevokeOAuthV2 |
Uygulama kimliği | //RevokeOAuthV2/AppId |
RevokeOAuthV2 |
Son kullanıcı kimliği | //RevokeOAuthV2/EndUserId |
SetOAuthV2Info |
Erişim jetonu | //SetOAuthV2Info/AccessToken |
SetOAuthV2Info |
Özellik değerleri | //SetOAuthV2Info/Attributes/Attribute |
DeleteOAuthV2Info |
Erişim jetonu değeri | //DeleteOAuthV2Info/AccessToken |
DeleteOAuthV2Info |
Yetkilendirme kodu değeri | //DeleteOAuthV2Info/AuthorizationCode |
StatisticsCollector |
İstatistik değeri | //StatisticsCollector/Statistics/Statistic |
VerifyAPIKey |
Sabit kodlanmış API anahtarı | //VerifyAPIKey/APIKey |
Özel maskeleri yönetme
Özel bir API, kimliği tanımlayabilecek bilgi (PII) olarak tanımladığınız belirli alanları maskelemek için özelleştirilmiş bir XPath ifadeleri listesi göndermenize olanak tanır. Böylece, benzersiz veri gizliliği ihtiyaçlarınız karşılanır.
Kuruluşunuzun özel kimliği tanımlayabilecek bilgiler (PII) maskelerini /v1/organizations/<var>ORG_NAME/uapim/proxymasks Edge Management API uç noktasını kullanarak yönetebilirsiniz. Bu işlemleri gerçekleştirmek için orgadmin rolüne sahip olmanız gerekir.
API, belirli bir kuruluş için proxymasks adlı tek bir XPath listesi üzerinde çalışır.
| Yöntem | Kaynak | Özet | Açıklama |
|---|---|---|---|
GET |
/v1/organizations/ORG_NAME/uapim/proxymasks |
"proxymasks" XPath listesini alma | Belirli bir kuruluş için "proxymasks" ile ilgili XPath ifadelerinin tam listesini alır. |
PUT |
/v1/organizations/ORG_NAME/uapim/proxymasks |
"proxymasks" XPath listesini oluşturma veya değiştirme | "proxymasks" listesi yoksa oluşturur, varsa içeriğini tamamen değiştirir. |
DELETE |
/v1/organizations/ORG_NAME/uapim/proxymasks |
"proxymasks" XPath listesini silin. | Kuruluş için "proxymasks" listesindeki tüm XPath'leri siler. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/append |
XPath'leri "proxymasks" listesine ekleme | Mevcut "proxymasks" listesinin sonuna bir veya daha fazla XPath dizesi ekler. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems |
"proxymasks" listesinden belirli XPath'leri silme | "proxymasks" listesinden belirli XPath dizelerini kaldırır. Tam dizelerle eşleşir. |
XPath listesinden öğe oluşturma, değiştirme, alma, ekleme veya silme ile ilgili tüm istekler ve başarılı yanıtlar için aşağıdaki JSON şeması kullanılır:
{ "xpaths": [ "//Path/To/Element" ] }
| Alan | Tür | Açıklama |
|---|---|---|
xpaths |
dize dizisi | Maskelenecek XPath ifadesi dizelerinin listesi. Bu alan zorunludur. |
1. Özel XPath listesini oluşturma veya değiştirme (PUT)
Yeni bir özel liste oluşturmak veya mevcut bir listenin içeriğini tamamen değiştirmek için PUT yöntemini kullanın. Mevcut XPath'lerin üzerine yazılır.
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" ] }'
Güncelleme tamamlandığında aşağıdaki mesajla birlikte 201 Created veya 200K yanıtı gösterilir: Success response (201 Created or 200 OK)
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
2. Özel XPath listesini alma (GET)
Mevcut özel XPath ifadeleri listesini almak için GET yöntemini kullanın.
curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Alma işlemi tamamlandığında aşağıdaki mesajı içeren bir 200K yanıtı gösterilir:Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
3. Listeye XPath'ler ekleme (POST append)
Mevcut içeriğin üzerine yazmadan mevcut listeye bir veya daha fazla XPath ifadesi eklemek için POST yöntemini kullanın.
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" ] }'
Ekleme işlemi tamamlandığında aşağıdaki mesajla birlikte 200K yanıtı gösterilir: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. Listeden belirli XPath'leri silme (POST deleteItems)
Mevcut listeden belirli XPath ifadelerini kaldırmak için POST yöntemini kullanın. İstek, kaldırılacak tam XPath dizelerini içermelidir.
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" ] }'
Silme işlemi tamamlandığında aşağıdaki mesajla birlikte 200K yanıtı gösterilir: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. Özel XPath listesinin tamamını silme (DELETE)
Özel XPath listesini tamamen kaldırmak için DELETE yöntemini kullanın. Bu işlem yalnızca özel maskeleri kaldırır. Varsayılan maskeler uygulanmaya devam eder.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Silme işlemi tamamlandığında aşağıdaki mesajla birlikte 204 No Content yanıtı gösterilir: Success response (204 No Content):
HTTP/1.1 204 No Content
Maskelenmiş paketleri güncelleme
Özel kimliği tanımlayabilecek bilgileri maskeleme yapılandırmanızı değiştirdiğinizde, daha önce eski bir maske yapılandırmasıyla yüklenen API proxy paketlerinin en son maskelerle yeniden işlenmesi gerekir. Paketleri en son maskeleme ayarlarıyla güncellemek için lütfen gerekli yeniden işleme sürecini başlatmak üzere bir destek kaydı oluşturun.