Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Mengelola penyamaran PII dalam proxy dan paket sharedflow
Sebagai bagian dari proses sinkronisasi, integrasi konektor hub API mengupload paket proxy API Anda ke hub API. Paket ini dapat berisi data sensitif, atau Informasi Identitas Pribadi (PII), dalam konfigurasi kebijakan. Fitur ini memungkinkan Anda menyamarkan kolom PII yang teridentifikasi sebelum bundle diupload ke hub API.
Pendekatan penyamaran
Penyamaran PII diterapkan menggunakan ekspresi XPath untuk menargetkan elemen tertentu dalam konfigurasi kebijakan di paket proxy dan sharedflow berformat XML, tetapi tidak untuk elemen XML umum lainnya dalam paket. Fitur ini dibagi menjadi dua bagian:
Masker default
Apigee Edge menyertakan daftar ekspresi XPath bawaan yang telah ditentukan sebelumnya yang secara otomatis menargetkan kolom PII umum. Masker ini diterapkan secara otomatis selama proses upload.
Daftar masker default:
| Nama Kebijakan | Deskripsi Kolom (atau Nilai) | Ekspresi XPath |
|---|---|---|
AccessEntity |
ID entitas | //AccessEntity/EntityIdentifier |
AccessEntity |
ID sekunder | //AccessEntity/SecondaryIdentifier |
BasicAuthentication |
Nilai kolom pengguna | //BasicAuthentication/User |
BasicAuthentication |
Nilai kolom sandi | //BasicAuthentication/Password |
ConnectorCallout |
Isi permintaan JSON untuk dikirim ke ekstensi | //ConnectorCallout/Input |
FlowCallout |
Nilai Parameter yang diteruskan ke balon alur | //FlowCallout/Parameter//FlowCallout/Parameters/Parameter |
HMAC |
Kunci rahasia yang digunakan untuk penghitungan HMAC | //HMAC/SecretKey |
HMAC |
Konten pesan yang akan ditandatangani | //HMAC/Message |
HMAC |
Nilai verifikasi HMAC | //HMAC/VerificationValue |
JavaCallout |
Properti yang diteruskan (konfigurasi/data sensitif) | //JavaCallout/Properties/Property |
Javascript |
Sumber inline | //Javascript/Source |
Javascript |
Nilai properti | //Javascript/Properties/Property |
GenerateJWS |
Nilai kunci pribadi | //GenerateJWS/PrivateKey/Value |
GenerateJWS |
Sandi kunci pribadi | //GenerateJWS/PrivateKey/Password |
GenerateJWS |
ID kunci pribadi | //GenerateJWS/PrivateKey/Id |
GenerateJWS |
Nilai kunci rahasia | //GenerateJWS/SecretKey/Value |
GenerateJWS |
ID kunci rahasia | //GenerateJWS/SecretKey/Id |
VerifyJWS |
Kunci publik JWKS | //VerifyJWS/PublicKey/JWKS |
VerifyJWS |
Nilai kunci publik | //VerifyJWS/PublicKey/Value |
VerifyJWS |
Nilai kunci rahasia | //VerifyJWS/SecretKey/Value |
GenerateJWT |
Nilai header penting | //GenerateJWT/CriticalHeaders |
GenerateJWT |
Nilai kunci pribadi yang digunakan untuk menandatangani JWT | //GenerateJWT/PrivateKey/Value |
GenerateJWT |
Sandi kunci pribadi | //GenerateJWT/PrivateKey/Password |
GenerateJWT |
ID kunci pribadi | //GenerateJWT/PrivateKey/Id |
GenerateJWT |
Nilai kunci rahasia | //GenerateJWT/SecretKey/Value |
GenerateJWT |
ID kunci rahasia | //GenerateJWT/SecretKey/Id |
VerifyJWT |
Kunci publik | //VerifyJWT/PublicKey/Value |
VerifyJWT |
Kunci rahasia | //VerifyJWT/SecretKey/Value |
KeyValueMapOperations |
Nilai untuk entri awal dan operasi PUT | //KeyValueMapOperations/InitialEntries/Entry/Value//KeyValueMapOperations/Put/Value |
Ldap |
Nilai kolom nama pengguna dan sandi | //Ldap/Authentication/UserName//Ldap/Authentication/Password |
OAuthV1 |
Token | //OAuthV1/Tokens/Token |
OAuthV1 |
Token akses | //OAuthV1/AccessToken |
OAuthV1 |
Nilai atribut | //OAuthV1/Attributes/Attribute |
OAuthV1 |
Kode verifikasi | //OAuthV1/VerifierCode |
OAuthV1 |
ID pengguna aplikasi | //OAuthV1/AppUserId |
OAuthV1 |
Minta token | //OAuthV1/RequestToken |
OAuthV2 |
Nilai atribut | //OAuthV2/Attributes/Attribute |
GetOAuthV2Info |
Token akses | //GetOAuthV2Info/AccessToken |
GetOAuthV2Info |
Kode otorisasi | //GetOAuthV2Info/AuthorizationCode |
GetOAuthV2Info |
ID Klien | //GetOAuthV2Info/ClientId |
GetOAuthV2Info |
Token refresh | //GetOAuthV2Info/RefreshToken |
RevokeOAuthV2 |
ID Aplikasi | //RevokeOAuthV2/AppId |
RevokeOAuthV2 |
ID pengguna akhir | //RevokeOAuthV2/EndUserId |
SetOAuthV2Info |
Token akses | //SetOAuthV2Info/AccessToken |
SetOAuthV2Info |
Nilai atribut | //SetOAuthV2Info/Attributes/Attribute |
DeleteOAuthV2Info |
Nilai token akses | //DeleteOAuthV2Info/AccessToken |
DeleteOAuthV2Info |
Nilai kode otorisasi | //DeleteOAuthV2Info/AuthorizationCode |
StatisticsCollector |
Nilai statistik | //StatisticsCollector/Statistics/Statistic |
VerifyAPIKey |
Kunci API yang di-hardcode | //VerifyAPIKey/APIKey |
Mengelola masker kustom
API khusus memungkinkan Anda mengirimkan daftar ekspresi XPath yang disesuaikan untuk menyamarkan kolom tertentu yang Anda identifikasi sebagai PII, sehingga memastikan kebutuhan privasi data unik Anda terpenuhi.
Anda dapat mengelola mask PII kustom organisasi menggunakan endpoint API pengelolaan Edge /v1/organizations/<var>ORG_NAME/uapim/proxymasks. Anda harus memiliki peran orgadmin untuk melakukan operasi ini.
API ini beroperasi pada satu daftar XPath bernama proxymasks untuk organisasi tertentu.
| Metode | Resource | Ringkasan | Deskripsi |
|---|---|---|---|
GET |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Mengambil daftar XPath 'proxymasks' | Mendapatkan daftar lengkap ekspresi XPath untuk 'proxymasks' untuk organisasi tertentu. |
PUT |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Membuat atau Mengganti daftar XPath 'proxymasks' | Membuat daftar 'proxymasks' jika belum ada, atau mengganti kontennya sepenuhnya jika sudah ada. |
DELETE |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Hapus daftar XPath 'proxymasks' | Menghapus semua XPath dalam daftar 'proxymasks' untuk organisasi. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/append |
Tambahkan XPath ke daftar 'proxymasks' | Menambahkan satu atau beberapa string XPath ke akhir daftar 'proxymasks' yang ada. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems |
Menghapus XPath tertentu dari daftar 'proxymasks' | Menghapus string XPath tertentu dari daftar 'proxymasks'. Mencocokkan string yang sama persis. |
Semua permintaan dan respons yang berhasil untuk membuat, mengganti, mendapatkan, menambahkan, atau menghapus item dari daftar XPath menggunakan skema JSON berikut:
{ "xpaths": [ "//Path/To/Element" ] }
| Kolom | Jenis | Deskripsi |
|---|---|---|
xpaths |
array string | Daftar string ekspresi XPath yang akan disamarkan. Kolom ini wajib diisi. |
1. Membuat atau mengganti daftar XPath kustom (PUT)
Gunakan metode PUT untuk membuat daftar kustom baru atau mengganti sepenuhnya konten daftar yang ada. XPath yang ada akan ditimpa.
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" ] }'
Setelah update selesai, respons 201 Created atau 200K akan ditampilkan dengan pesan berikut: Success response (201 Created or 200 OK)
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
2. Mengambil daftar XPath kustom (GET)
Gunakan metode GET untuk mengambil daftar ekspresi XPath kustom saat ini.
curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Setelah pengambilan selesai, respons 200K akan ditampilkan dengan pesan berikut:Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
3. Menambahkan XPath ke daftar (POST append)
Gunakan metode POST untuk menambahkan satu atau beberapa ekspresi XPath ke daftar yang ada tanpa menimpa konten saat ini.
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" ] }'
Setelah penambahan selesai, respons 200K akan ditampilkan dengan pesan berikut: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. Menghapus XPath tertentu dari daftar (POST deleteItems)
Gunakan metode POST untuk menghapus ekspresi XPath tertentu dari daftar yang ada. Permintaan harus berisi string XPath persis yang akan dihapus.
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" ] }'
Setelah penghapusan selesai, respons 200K akan ditampilkan dengan pesan berikut: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. Menghapus seluruh daftar XPath kustom (DELETE)
Gunakan metode DELETE untuk menghapus daftar XPath kustom sepenuhnya. Tindakan ini hanya akan menghapus mask kustom; mask default akan tetap diterapkan.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Setelah penghapusan selesai, respons 204 No Content akan ditampilkan dengan pesan berikut: Success response (204 No Content):
HTTP/1.1 204 No Content
Memperbarui bundle yang disamarkan
Saat Anda mengubah konfigurasi masking PII kustom, paket proxy API yang sebelumnya diupload dengan konfigurasi masking yang lebih lama harus diproses ulang dengan masking terbaru. Untuk memperbarui paket dengan setelan penyamaran terbaru, ajukan tiket dukungan untuk memulai pemrosesan ulang yang diperlukan.