Masking Data in JSON Payloads

You can mask the data in the JSON format payloads using the <JSONMaskFields> tag in the log policy XML file. This table explains the field names for masking the data in an JSON payload.

Parameters For Masking Data in JSON Payload
Parameter Description
MaskFieldPath Specifies the JSON path for the field. The value of this field is masked. For example, BookStore.Book.[0].Author
RemoveField

This is a Boolean field that indicates if the field specified by MaskFieldPath tag is logged or not. The possible values are Y and N.

  • If the value of this field is Y, the field specified by MaskFieldPath tag is not logged.
  • If the value of this field is N, the field specified by MaskFieldPath tag is masked and logged.

    Note: The default value is N.

StartIndex Specifies an index of the field value at which masking starts. If the RemoveField field is set to Y, this is ignored.
EndIndex Specifies an Index of the field value at which masking ends. Specifies an index of the field value at which masking starts. If the RemoveField field is set to Y, this is ignored.
LengthOfClearAtStart Specifies the number of characters to be left clear at the beginning. Specifies an index of the field value at which masking starts. If the RemoveField field is set to Y, this is ignored.
LengthOfClearAtEnd Specifies the number of characters to be left clear at the end. Specifies an index of the field value at which masking starts. If the RemoveField field is set to Y, this is ignored.

Example of Data Masking in JSON Payload

<JSONMaskFields>
              <JSONMaskField>
                    <MaskFieldPath>BookStore.Book.[0].Author</MaskFieldPath>
                    <RemoveField>Y</RemoveField>
                    <StartIndex>0</StartIndex>
                    <EndIndex>10</EndIndex>
                    <LengthOfClearAtStart>4</LengthOfClearAtStart>
                    <LengthOfClearAtEnd>6</LengthOfClearAtEnd>
              </JSONMaskField>    <JSONMaskField>
                    <MaskFieldPath>BookStore.Book.[0].Title</MaskFieldPath>
                    <RemoveField>N</RemoveField>
                    <StartIndex>6</StartIndex>
                    <EndIndex>12</EndIndex>
                    <LengthOfClearAtStart>4</LengthOfClearAtStart>
                    <LengthOfClearAtEnd>6</LengthOfClearAtEnd>
              </JSONMaskField>
              <JSONMaskField>
                    <MaskFieldPath>BookStore.Book.[0].ISBN</MaskFieldPath>
                    <RemoveField>N</RemoveField>
                    <StartIndex>3</StartIndex>
                    <EndIndex>9</EndIndex>
                    <LengthOfClearAtStart>4</LengthOfClearAtStart>
                    <LengthOfClearAtEnd>6</LengthOfClearAtEnd>
              </JSONMaskField>
        </JSONMaskFields>