PII Update

The Data Scan PII Elements Update API allows users to update privacy information (PII) details for a specific column within a specified data source, object path, and column name. This document provides details on how to use the API, the required input parameters, and the expected output.

Note: To obtain the <auth token>, please refer to the Step-by-Step Guide to Obtain Your Auth Token

# Import the ProtectoVault class from the protecto_ai module
from protecto_ai import ProtectoVault
# Create an instance of ProtectoVault with your authentication token
obj = ProtectoVault("<auth_token>")

HTTP Method: PUT

Endpoint: /update

Code Snippet

{ 
"data_source_name": "Datasource3", 
"object_name": ["db1","schema1","table1"], 
"column_name": "column_1", 
"pi_details": ["ADDRESS"] 
} 
 

input Parameters :

• data_source_name:
  • Description: A user-defined identifier for the data source. Users can provide any name for this identifier.
  • Type: String
  • Example: "Datasource3"
• object_name:
  • Description: The object path indicating the database, schema, and table.
  • Type: Array of Strings
  • Example: ["db1", "schema1", "table1"]
• column_name:
  • Description: The name of the column for which privacy information is to be updated.
  • Type: String
  • Example: "column_1"

Output :

The API response will provide information about the success or failure of the PII details update.

{ 
  "data": { 
"message": "pi_details updated successfully for object name: ["db1","schema1","table1"] ,column_name: column_1 as ['ADDRESS']." 
      },  
  "success": "true", 
  "error": { 
    "message": "" 
  } 
}