List Built-In Classifiers

Audience: Data Owners and Data Governors

Content Summary: Immuta's Sensitive Data Discovery (SDD) supports both built-in and custom classifiers. You can view all built-in classifiers on the Classifiers Reference page, or you can use the Immuta API to list all built-in classifiers, as illustrated below.

Attributes

Attributes of classifiers and templates are provided on the Sensitive Data Discovery API page. However, attributes specific to listing classifiers are outlined in the table below.

Attribute	Description
sortField	`string` The field by which to sort the search results: `id`, `name`, `displayName`, `type`, `createdAt`, or `updatedAt`.
sortOrder	`string` Denotes whether to sort the results in ascending (`asc`) or descending (`desc`) order. Default is `asc`.
offSet	`integer` Use in combination with `limit` to fetch pages.
limit	`integer` Limits the number of results displayed per page.
type	`array[string]` Searches for classifiers based on classifier type: `builtIn`.
searchText	`string` A partial, case-insensitive search on name.

Response Details

The response lists all built-in classifiers that are currently supported in Immuta SDD and their details, including their name and description. For example,

{
  "count": 67,
  "hits": [
    {
      "createdBy": {
        "id": 21,
        "name": "Immuta System Account",
        "email": "immuta_system@immuta.com"
      },
      "name": "AGE",
      "displayName": "Age",
      "description": "Detects numeric strings between 10 and 199, provided the column header contains text such as `age`, `year`, `years`, `yr`, or `yrs`.",
      "type": "builtIn",
      "config": {
        "minConfidence": 0.7,
        "tags": [
          "Discovered.PII",
          "Discovered.Identifier Indirect",
          "Discovered.PHI",
          "Discovered.Entity.Age"
        ],
        "conditionalTags": {}
      },
      "id": 3,
      "createdAt": "2021-10-28T07:34:58.761Z",
      "updatedAt": "2021-10-28T07:34:58.761Z"
    }
  ]
}

List Built-In Classifiers

Generate your API key on the API Keys tab on your profile page and save the API key somewhere secure. You will include this API key in the authorization header when you make a request to the Immuta API or use it to configure your instance with the Immuta CLI.

List built-in classifiers using one of these methods:

Immuta CLIHTTP API

Immuta CLI

immuta api sdd/classifier?sortField=name&sortOrder=asc&limit=100&type=builtIn

HTTP API

curl \
    --request GET \
    --header "Content-Type: application/json" \
    --header "Authorization: 12345678900000" \
    https://your-immuta-url.immuta.com/sdd/classifier?sortField=name&sortOrder=asc&limit=100&type=builtIn

If the request was successful, you will receive a list of built-in classifiers.

What's Next

Run Sensitive Data Discovery on Data Sources: Trigger SDD to run on specified data sources.
Create a Template: Although only Data Governors can create classifiers, Data Owners can add classifiers to templates, which they then apply to their data sources to override minConfidence or tags for classifiers within the template.
Create a Custom Classifier: Data Governors can create custom classifiers to define their own regular expressions, dictionaries, and tags that SDD will use to detect sensitive data.