คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ
Apigee X info
จัดการการมาสก์ PII ในพร็อกซีและแพ็กเกจ SharedFlow
การผสานรวมตัวเชื่อมต่อ API Hub จะอัปโหลดชุดพร็อกซี API ไปยัง API Hub ซึ่งเป็นส่วนหนึ่งของกระบวนการซิงค์ ซึ่งอาจมีข้อมูลที่ละเอียดอ่อนหรือข้อมูลส่วนบุคคลที่ระบุตัวบุคคลนั้นได้ (PII) ภายในการกำหนดค่านโยบาย ฟีเจอร์นี้ช่วยให้คุณมาสก์ช่อง PII ที่ระบุได้ก่อนที่จะอัปโหลด Bundle ไปยัง API Hub
วิธีการมาสก์
การมาสก์ PII จะใช้โดยใช้นิพจน์ XPath เพื่อกำหนดเป้าหมายองค์ประกอบที่เฉพาะเจาะจงในการกำหนดค่านโยบายภายในพร็อกซีและบันเดิล Sharedflow ที่จัดรูปแบบ XML แต่จะไม่กำหนดเป้าหมายองค์ประกอบ XML ทั่วไปอื่นๆ ภายในบันเดิล ฟีเจอร์นี้แบ่งออกเป็น 2 ส่วนดังนี้
มาสก์เริ่มต้น
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 ที่กำหนดเองขององค์กรได้โดยใช้/v1/organizations/<var>ORG_NAME/uapim/proxymasksปลายทาง Edge Management API คุณต้องมีบทบาท 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 อย่างน้อย 1 รายการต่อท้ายรายการ "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 เพื่อสร้างรายการที่กำหนดเองใหม่หรือแทนที่เนื้อหาของรายการที่มีอยู่ทั้งหมด ระบบจะเขียนทับ 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" ] }
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)
ใช้วิธี POST เพื่อผนวกนิพจน์ XPath อย่างน้อย 1 รายการไปยังรายการที่มีอยู่โดยไม่ต้องเขียนทับเนื้อหาปัจจุบัน
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)
ใช้วิธี 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" ] }
5. ลบรายการ XPath ที่กำหนดเองทั้งหมด (DELETE)
ใช้วิธี DELETE เพื่อนำรายการ XPath ที่กำหนดเองออกโดยสมบูรณ์ การดำเนินการนี้จะนำเฉพาะมาสก์ที่กำหนดเองออก ส่วนมาสก์เริ่มต้นจะยังคงมีผล
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
การอัปเดต Bundle ที่มาสก์
เมื่อแก้ไขการกำหนดค่าการมาสก์ PII ที่กำหนดเอง คุณจะต้องประมวลผล App Bundle ของพร็อกซี API ที่อัปโหลดก่อนหน้านี้ด้วยการกำหนดค่าการมาสก์แบบเก่าอีกครั้งโดยใช้การมาสก์ล่าสุด หากต้องการอัปเดตแพ็กเกจด้วยการตั้งค่าการมาสก์ล่าสุด โปรดส่งคำขอรับตั๋วสนับสนุนเพื่อเริ่มการประมวลผลซ้ำที่จำเป็น