จัดการการมาสก์ข้อมูลส่วนบุคคลที่ระบุตัวบุคคลนั้นได้ (PII) ในแพ็กเกจพร็อกซีและ Sharedflow

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X
info

จัดการการมาสก์ PII ในพร็อกซีและ Bundle ของ Sharedflow

การผสานรวมตัวเชื่อมต่อ API Hub จะอัปโหลด Bundle ของพร็อกซี API ไปยัง API Hub ซึ่งเป็นส่วนหนึ่งของกระบวนการซิงค์ Bundle เหล่านี้อาจมีข้อมูลที่ละเอียดอ่อนหรือข้อมูลส่วนบุคคลที่ระบุตัวบุคคลนั้นได้ (PII) ภายในการกำหนดค่าของนโยบาย ฟีเจอร์นี้ช่วยให้คุณมาสก์ช่อง PII ที่ระบุได้ก่อนที่จะอัปโหลด Bundle ไปยัง API Hub

วิธีการมาสก์

ระบบจะใช้การมาสก์ PII โดยใช้ XPath Expression เพื่อกำหนดเป้าหมายองค์ประกอบที่เฉพาะเจาะจงในการกำหนดค่าของนโยบายใน Bundle ของพร็อกซีและ Sharedflow ที่จัดรูปแบบ XML แต่จะไม่ใช้กับองค์ประกอบ XML ทั่วไปอื่นๆ ภายใน Bundle ฟีเจอร์นี้แบ่งออกเป็น 2 ส่วน

การมาสก์เริ่มต้น

Apigee Edge มีรายการ XPath Expression ที่กำหนดไว้ล่วงหน้าและในตัว ซึ่งกำหนดเป้าหมายช่อง PII ทั่วไปโดยอัตโนมัติ ระบบจะใช้การมาสก์เหล่านี้โดยอัตโนมัติในระหว่างกระบวนการอัปโหลด

รายการการมาสก์เริ่มต้น

ชื่อนโยบาย คำอธิบายช่อง (หรือค่า) XPath Expression
AccessEntity ตัวระบุเอนทิตี //AccessEntity/EntityIdentifier
AccessEntity ตัวระบุรอง //AccessEntity/SecondaryIdentifier
BasicAuthentication ค่าในช่องผู้ใช้ //BasicAuthentication/User
BasicAuthentication ค่าในช่องรหัสผ่าน //BasicAuthentication/Password
ConnectorCallout เนื้อหาคำขอ JSON ที่จะส่งไปยังส่วนขยาย //ConnectorCallout/Input
FlowCallout ค่าพารามิเตอร์ที่ส่งไปยัง Flow Callout //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 Expression ที่กำหนดเองเพื่อมาสก์ช่องที่เฉพาะเจาะจงซึ่งคุณระบุว่าเป็น 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 Expression ทั้งหมดสำหรับ "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 Expression ที่จะมาสก์ ต้องระบุข้อมูลในช่องนี้

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 Expression ที่กำหนดเองปัจจุบัน

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 Expression อย่างน้อย 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 Expression ที่เฉพาะเจาะจงออกจากรายการที่มีอยู่ คำขอต้องมีสตริง 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 ที่กำหนดเอง ระบบจะต้องประมวลผล Bundle ของพร็อกซี API ที่อัปโหลดไว้ก่อนหน้านี้ด้วยการกำหนดค่าการมาสก์ที่เก่ากว่าอีกครั้งด้วยการมาสก์ล่าสุด หากต้องการอัปเดต Bundle ด้วยการตั้งค่าการมาสก์ล่าสุด โปรดส่งตั๋วสนับสนุนเพื่อเริ่มการประมวลผลซ้ำที่จำเป็น