Data Masking Processing

Introduces how to call the content review interface for data masking processing.

The Content Review interface's Data Masking field is used to detect sensitive information in the content uploaded or sent by users and return the masked content in the specified manner.

After the security administrator has established appropriate masking policies for the enterprise or organization, the operator calling the API interface only needs to add the sendBack field in their content review request to detect sensitive information in the uploaded or sent content and perform masking processing.

If the system is unable to detect the content uploaded or sent by users, it will return a specific error message.

The field requires input of a required type attribute, indicating the way the file is returned. The Type attribute supports the following options:
The API interface supports masking operations for the following document types:
  • Microsoft Word documents
  • Microsoft PowerPoint documents
  • Microsoft Excel documents
  • Plain text documents
  • And other common office documents
Restriction: As of the current system version, when performing masking processing on content in the email channel, the system only supports normal masking of the email body content and cannot perform masking operations on attachments in the email, nor can it return the attachment files.

Return the Masked Content to the Current Path

By adding the following field to the content review request, you can set the system to perform masking processing on the file according to the masking policy and return the masked content to the current path.

{
                "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
                ......
                "sendBack": {
                "type": "response"  # Return the masked content to the current path
                },
                "redaction": {
                "enable": true  # The request takes effect when enable is True.
                }
                }

Send the Masked Content to the Specified URL

By adding the following field to the content review request, you can set the system to perform masking processing on the file according to the masking policy and upload the masked file to the specified file server.
Note: The masking policy channel supports HTTPS.
{
                "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
                ......
                "sendBack": {
                "type": "httpUpload",
                "url": "http://172.11.11.6/callback"  # Send the masked content to this url
                },
                "redaction": {
                "enable": true  # The request takes effect when enable is True.
                }
                }

Upload the Masked Content to s3

By adding the following field to the content review request, you can set the system to perform masking processing on the file according to the masking policy and upload the masked file to the specified location in the s3 object storage.

{
                "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
                ......
                "sendBack": {
                "type": "s3",
                "s3Bucket": "test",
                "s3Region": "", # Upload the masked file to this location. The value here is the region name when using s3. If running on EC2 and using AWS IAM role, the following three items can be omitted
                "accessKey": "aws_accessKey",
                "secretKey": "aws_secretKey",
                "endpointUrl": ""
                },
                "redaction": {
                "enable": true # The request takes effect when enable is true
                }
                }

Upload the Masked Content to swift

By adding the following field to the content review request, you can set the system to perform masking processing on the file according to the masking policy and upload the masked file to the specified location in the swift object storage.

{
                "queryID": "1075893f-b0ed-4a76-a07d-df3d2fc0de46",
                ......
                "sendBack": {
                "type": "swift",
                "X-Auth-Token": "AUTH_tkbdac2a3474ee4d6396133c99cfd962c8",  # The authentication token when using swift. If the provided X-Auth-Token is valid, the following three items can be omitted.
                "authUrl": "http://172.22.117.120:8080/auth/v1.0",
                "X-Auth-User": "test",
                "X-Auth-Key": "test",
                "objectUrl": "http://172.22.117.120:8080/auth/v1.0/AUTH_test/container1/1.txt",  # Upload the masked file to this object URL location in swift object storage. Choose one between objectUrl and ContainterUrl.
                "containerUrl": "", # Upload the masked file to this container URL location in swift object storage. Choose one between objectUrl and ContainterUrl.
                },
                "redaction":{
                "enable": true   # The request takes effect when enable is True.
                }
                }