本頁面由 Cloud Translation API 翻譯而成。

管理 Proxy 和 Sharedflow 套件中的個人識別資訊 (PII) 遮蓋

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

管理 Proxy 和 Sharedflow 套件中的 PII 遮蓋

在同步處理程序中，API 中心連結器整合會將 API Proxy 套件上傳至 API 中心。這些組合可能包含機密資料或個人識別資訊 (PII)，因此請務必檢查政策設定。這項功能可讓您在將套件上傳至 API 中樞前，遮蓋識別出的個人識別資訊欄位。

遮蓋方法

系統會使用 XPath 運算式，在 XML 格式的 Proxy 和共用流程套件中，針對政策設定內的特定元素套用 PII 遮蓋，但不會對套件中的其他一般 XML 元素套用。這項功能分為兩部分：

預設遮罩

Apigee Edge 內建預先定義的 XPath 運算式清單，可自動鎖定常見的 PII 欄位。系統會在上傳過程中自動套用這些遮罩。

預設遮罩清單：

政策名稱	欄位 (或值) 說明	XPath 運算式
`AccessEntity`	實體 ID	`//AccessEntity/EntityIdentifier`
`AccessEntity`	次要 ID	`//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`	私密金鑰 ID	`//GenerateJWS/PrivateKey/Id`
`GenerateJWS`	密鑰值	`//GenerateJWS/SecretKey/Value`
`GenerateJWS`	密鑰 ID	`//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`	私密金鑰 ID	`//GenerateJWT/PrivateKey/Id`
`GenerateJWT`	密鑰值	`//GenerateJWT/SecretKey/Value`
`GenerateJWT`	密鑰 ID	`//GenerateJWT/SecretKey/Id`
`VerifyJWT`	公開金鑰	`//VerifyJWT/PublicKey/Value`
`VerifyJWT`	Secret 金鑰	`//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`	應用程式使用者 ID	`//OAuthV1/AppUserId`
`OAuthV1`	要求權杖	`//OAuthV1/RequestToken`
`OAuthV2`	屬性值	`//OAuthV2/Attributes/Attribute`
`GetOAuthV2Info`	存取權杖	`//GetOAuthV2Info/AccessToken`
`GetOAuthV2Info`	授權碼	`//GetOAuthV2Info/AuthorizationCode`
`GetOAuthV2Info`	用戶端 ID	`//GetOAuthV2Info/ClientId`
`GetOAuthV2Info`	重新整理權杖	`//GetOAuthV2Info/RefreshToken`
`RevokeOAuthV2`	應用程式 ID	`//RevokeOAuthV2/AppId`
`RevokeOAuthV2`	使用者 ID	`//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 的特定欄位，確保滿足獨特的資料隱私權需求。

您可以使用 /v1/organizations/<var>ORG_NAME/uapim/proxymasks Edge 管理 API 端點，管理貴機構的自訂 PII 遮蓋。您必須具備 orgadmin 角色才能執行這些作業。

這個 API 會針對特定機構，在名為 proxymasks 的單一 XPath 清單上運作。

方法	資源	摘要	說明
`GET`	`/v1/organizations/ORG_NAME/uapim/proxymasks`	擷取「proxymasks」XPath 清單	取得指定機構的「proxymasks」完整 XPath 運算式清單。
`PUT`	`/v1/organizations/ORG_NAME/uapim/proxymasks`	建立或取代「proxymasks」XPath 清單	如果「proxymasks」清單不存在，則會建立該清單；如果存在，則會完全取代其內容。
`DELETE`	`/v1/organizations/ORG_NAME/uapim/proxymasks`	刪除「proxymasks」XPath 清單	刪除機構「proxymasks」清單中的所有 XPath。
`POST`	`/v1/organizations/ORG_NAME/uapim/proxymasks/append`	將 XPath 附加至「proxymasks」清單	在現有的「proxymasks」清單結尾新增一或多個 XPath 字串。
`POST`	`/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems`	從「proxymasks」清單中刪除特定 XPath	從「proxymasks」清單中移除特定 XPath 字串。比對完全相符的字串。

建立、取代、取得、附加或刪除 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 運算式附加至現有清單，而不覆寫目前內容。

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

更新遮蓋的套件

修改自訂 PII 遮蓋設定後，先前使用舊版遮蓋設定上傳的 API Proxy 套裝組合，必須使用最新遮蓋重新處理。如要使用最新的遮蓋設定更新套裝組合，請提出支援單，啟動必要的重新處理程序。