logo

profileSet

Get all profile sets

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get profile sets. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting property if not provided

Responses
200

Success

400

Bad request

403

Forbidden access

get/profile-sets
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create profile set

Securityapi_key
Request
Request Body schema: application/json
required

The profile set to create

profileSetName
required
string <= 50 characters

The name of the profile set; it must be unique.

profileExpressionIds
Array of integers <int32>

Profile sets with profile expressions can no longer be created.

profileTypeExpressionIds
Array of integers <int32>

Profile sets with profile expressions can no longer be created.

classifierIds
Array of integers <int64>

The list of ID numbers that correspond to the profile classifiers that belong in this profile set.

description
string <= 50 characters

A description of the purpose of the profile set.

assignmentThreshold
integer <int32>

The confidence threshold that must be met or exceeded for the ASDD profiler to make a domain and algorithm assignment. This must be an integer from 1-100. If not specified, the value defaults to the application setting for ASDD called DefaultAssignmentThreshold.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/profile-sets
Request samples
application/json
{
  • "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  • "classifierIds": [
    ]
}
Response samples
application/json
{
  • "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  • "classifierIds": [
    ]
}

Get profile set by ID

Securityapi_key
Request
path Parameters
profileSetId
required
integer <int32>

The ID of the profile set to get

Responses
200

Success

403

Forbidden access

404

Not found

get/profile-sets/{profileSetId}
Response samples
application/json
{
  • "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  • "classifierIds": [
    ]
}

Update profile set by ID

Securityapi_key
Request
path Parameters
profileSetId
required
integer <int32>

The ID of the profile set to update

Request Body schema: application/json
required

The updated profile set

profileSetName
required
string <= 50 characters

The name of the profile set; it must be unique.

profileExpressionIds
Array of integers <int32>

Profile sets with profile expressions can no longer be created.

profileTypeExpressionIds
Array of integers <int32>

Profile sets with profile expressions can no longer be created.

classifierIds
Array of integers <int64>

The list of ID numbers that correspond to the profile classifiers that belong in this profile set.

description
string <= 50 characters

A description of the purpose of the profile set.

assignmentThreshold
integer <int32>

The confidence threshold that must be met or exceeded for the ASDD profiler to make a domain and algorithm assignment. This must be an integer from 1-100. If not specified, the value defaults to the application setting for ASDD called DefaultAssignmentThreshold.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/profile-sets/{profileSetId}
Request samples
application/json
{
  • "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  • "classifierIds": [
    ]
}
Response samples
application/json
{
  • "profileSetName": "FINDS_ALL_SENSITIVE_DATA",
  • "classifierIds": [
    ]
}

Delete profile set by ID

Securityapi_key
Request
path Parameters
profileSetId
required
integer <int32>

The ID of the profile set to delete

Responses
200

Success

403

Forbidden access

404

Not found

delete/profile-sets/{profileSetId}

Export a zip file of the specified profile set's configuration JSON and the files used by its classifiers

Securityapi_key
Request
path Parameters
profileSetId
required
integer <int32>

The ID of the profile set

Responses
201

Success

400

Bad request

401

Unauthorized access

404

Not found

post/profile-sets/{profileSetId}/export
Response samples
application/json
{
  • "asyncTaskId": 1,
  • "operation": "RULESET_REFRESH",
  • "reference": 13,
  • "status": "RUNNING",
  • "cancellable": false
}

Generate a report listing all usage of profile sets on the masking engine

Securityapi_key
Request
query Parameters
includeAssignmentDetail
required
boolean
Default: false

Whether to include extended, human-readable profile set assignment detail in the report.

profileSetType
string

Whether to filter by specific profile set type. If not specified, all profile set types are included.

Enum: "ASDD" "LEGACY"
connectorType
string

Whether to filter by specific connector type. If not specified, all connector types are included.

Enum: "DATABASE" "FILE" "MAINFRAME"
environmentFilter
Array of strings

Report only usage occurring within the specified environment(s).

profileSetFilter
Array of strings

Report only usage of the specified profile set(s).

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

get/profile-sets/usage
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}
➔ Next to profileResultDatabase