プロキシ バンドルと共有フロー バンドルで個人情報（PII）のマスキングを管理する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご覧ください。 info

プロキシ バンドルと共有フロー バンドルで PII マスキングを管理する

同期プロセスの一環として、API Hub コネクタ統合により API プロキシ バンドルが API Hub にアップロードされます。これらのバンドルには、ポリシー構成内に機密データや個人を特定できる情報（PII）が含まれている場合があります。この機能を使用すると、バンドルが API Hub にアップロードされる前に、特定された PII フィールドをマスクできます。

マスキング アプローチ

PII マスキングは、XPath 式を使用して、XML 形式のプロキシと共有フローのバンドル内のポリシー構成内の特定の要素を対象に適用されますが、バンドル内の他の一般的な XML 要素には適用されません。この機能は、次の 2 つの部分に分かれています。

デフォルトのマスク

Apigee Edge には、一般的な PII フィールドを自動的にターゲットとする XPath 式の事前定義された組み込みリストが含まれています。これらのマスクは、アップロード プロセス中に自動的に適用されます。

デフォルトのマスクのリスト:

カスタム マスクを管理する

専用の API を使用すると、PII として識別した特定のフィールドをマスクするために、カスタマイズした XPath 式のリストを送信できます。これにより、独自のデータ プライバシーのニーズを満たすことができます。

組織のカスタム PII マスクは、/v1/organizations/<var>ORG_NAME/uapim/proxymasks Edge 管理 API エンドポイントを使用して管理できます。これらのオペレーションを実行するには、orgadmin ロールが必要です。

API は、特定の組織の proxymasks という名前の単一の XPath リストで動作します。

XPath リストのアイテムの作成、置換、取得、追加、削除のリクエストと成功したレスポンスはすべて、次の JSON スキーマを使用します。

{
  "xpaths": [
    "//Path/To/Element"
  ]
}

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 メソッドを使用して、現在のコンテンツを上書きせずに、1 つ以上の 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 プロキシ バンドルは、最新のマスクで再処理する必要があります。最新のマスキング設定でバンドルを更新するには、サポート チケットを送信して、必要な再処理を開始してください。