redact

redact ポリシーを使用して、要求の本文、応答の本文、およびアクティビティー・ログから、指定されたフィールドを完全に削除するか、それらのフィールドを編集します。法律、セキュリティー、その他の理由により、機密データ (例えば、クレジット・カードの詳細) を削除またはブロックするためにこのポリシーは役立ちます。

編集ポリシーの形式は次のとおりです。

- redact:
  title: title
  description: description
  actions:
    - action: remove_or_redact
      from: 
        - where_the_redaction_is_to_be_applied
      path: XPath_expression_for_field_to_remove_or_redact
                     .
                     .
                     .
           further action/from/path combinations
                     .
                     .
                     .

任意の数だけ action/from/path の組み合わせを指定できます。

以下の表に、このポリシーのプロパティーを示します。

表 1. redact ポリシーのプロパティー
プロパティー	必須	説明	データ型
title	いいえ	ポリシーのタイトル。	ストリング
description	いいえ	ポリシーの説明。	ストリング
action	いいえ	フィールドを削除するか、編集するか指定します。有効は値は以下のとおりです。 `remove`: 指定したフィールドを完全に削除します。 `redact`: データを見えなくするためにフィールドを編集 (「」で難読化) します。デフォルト値は、`redact` です。注: 数値を編集すると、編集された値は `*****` と示され、型は`ストリング`に変更されます。	ストリング
from	いいえ	編集が適用される場所を決定します。有効は値は以下のとおりです。 `all`: 要求の本文、応答の本文、およびアクティビティー・ログに編集を適用します。 `request`: 要求の本文にのみ編集を適用します。 `response`: 応答の本文にのみ編集を適用します。 `logs`: アクティビティー・ログにのみ編集を適用します。 1 つ以上の値を指定できます。デフォルト値は、`all` です。	ブール
path	はい	削除または編集を行うフィールドを定義する XPath 式を指定します。 API 要求および応答で JSON 形式と XML 形式のいずれを使用しているかにより、JSON または XML に基づいた XPath 式を作成できます。ペイロードが JSON の場合、JSON コンテンツの DataPower XML 表記 (JSONx) を使用して式を作成します。注: JSONx 表記は、削除または編集を行うフィールドの XPath 式を識別するためにのみ使用します。API Manager 内のいずれの応答本文の形式も変更しないでください。 JSON または XML に基づいて XPath 式を作成する方法について詳しくは、フィールドを編集するための XPath 式の作成を参照してください。	ストリング

例

# Specify separate remove and redact actions

- redact:
  title: remove secret field, redact address
  actions:
    - action: remove
      from: 
        - all
      path: /document/user/secret
    - action: redact
      from: 
        - request
        - response
      path: //*[@name='secondaryAddress']/*[@name='streetAddress']

最終更新: 2017 年 10 月 31 日