Help Center/Data Security Center/API Reference/Appendixes/Configuring a Dynamic Sensitive Data Masking Policy/SYMBOL
Updated on 2022-09-19 GMT+08:00
View PDF

SYMBOL

Mask the content before or after a special character and retain the rest characters.

Request Parameters

Table 1 Parameter description

Parameter

Mandatory

Type

Description

algorithm

Yes

String

Algorithm type, for example, SYMBOL

parameters

Yes

For details, see Table 2.

Parameters for configuring a data masking algorithm

Table 2 Parameters for configuring a data masking algorithm

Parameter

Mandatory

Type

Description

type

Yes

String

Character masking methods are described as follows:

  • CHAR: Character masking
  • RAND: Random masking

method

Yes

String

Masking method

If type is set to RAND, this parameter can be set as follows:

  • CHAR: Replace the data to be masked with characters.
  • DIGITAL: Replace the data to be masked with numbers.
  • BOTH: Replace the data to be masked with letters and numbers.

direction

Yes

Int

Masking direction

0: Mask the content before a special character.

1: Mask the content after a special character.

symbol

Yes

String

Specified special character

Example Request

{
    "mask_strategies": [
        {
            "name": "col1",
            "algorithm": "SYMBOL",
            "parameters": {
                "type": "CHAR",
                "direction": 1,
                "symbol": "@",
                "method": "x"
            }
        }
    ],
    "data": [
        {
            "col1": "test"
        }
    ]
}
Or
{
    "mask_strategies": [
        {
            "name": "col1",
"algorithm": "SYMBOL", // Parameter for configuring a data masking algorithm
            "parameters": {
                "type": "RAND",
                "direction": 0,
                "symbol": "@",
                "method": "CHAR"
            }
        }
    ],
    "data": [
        {
            "col1": "test"
        }
    ]
}