This API allows users to remove any user-defined personally identifiable information (PII) details that have been previously set for a specific column in a database object. This API helps in clearing out custom PII configurations if they are no longer needed or were set incorrectly.
For authentication, include the following token in the request headers:
Headers: {“Authorization”: “Bearer <AUTH_TOKEN>”}
Note: To obtain the <auth token>
, please refer to the Step-by-Step Guide to Obtain Your Auth Token.
Endpoint: /data-scan/pi-elements/delete
Method: PUT
Sample Input:
{ "data_source_name": "snowflake", "object_name": ["CustomerDB", "Marketingschema", "Customerstable"], "column_name": "CustomerID" }
Request Parameters:
- data_source_name (string): The name of the data source where the object is located.
- object_name (array of strings): The path to the specific object in the format Eg [database, schema, table].
- column_name (string): The name of the column for which the user-defined PII details are to be deleted.
Sample Response:
{ "data": { "message": "User defined pi_details deleted successfully for object name: ["CustomerDB", "Marketingschema", "Customerstable"], column_name: CustomerID." }, "success": "true", "error": { "message": "" } }
Response Parameters:
- data: Contains a message confirming the successful deletion of user-defined PII details for the specified column and object.