Custom Maskings

Manage custom maskings.

List custom maskings

get

Lists all custom maskings.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

limitinteger · min: 1 · max: 500Optional

This is the maximum number of results that may be returned. Fewer may be returned than the value of limit.

Do not depend on the number of results being fewer than the limit value to indicate that your query reached the end of the list of data, use the absence of after (see Cursors) instead. For example, if you set limit to 10 and 9 results are returned, there may be more data available.

If not set, the default limit (limit = 25) will be used. The maximum value for this parameter is 500.

Default: 25

afterstring · nullableOptional

This is the cursor that points to the end of the page of data that has been returned.

Responses

200

The list of custom maskings.

application/json

A page of custom maskings.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

An unexpected error has occurred.

application/json

get/customMaskings

HTTPcURLJavaScriptPython

GET /rest/protect/v1/customMaskings HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "cursors": {
    "after": null
  },
  "results": []
}

Add a new custom masking

post

Adds a new custom masking.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

application/json

namestringRequired

The name of the custom masking.

Example: myCustomHashing

Responses

201

The custom masking has been added.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

post/customMaskings

HTTPcURLJavaScriptPython

POST /rest/protect/v1/customMaskings HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "name": "myCustomHashing",
  "mappings": [
    {
      "provider": "Snowflake",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        },
        {
          "dataType": "number",
          "functionName": "hash_my_number"
        }
      ]
    },
    {
      "provider": "Databricks",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        }
      ]
    }
  ]
}

{
  "name": "myCustomHashing",
  "mappings": [
    {
      "provider": "Snowflake",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        },
        {
          "dataType": "number",
          "functionName": "hash_my_number"
        }
      ]
    },
    {
      "provider": "Databricks",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        }
      ]
    }
  ],
  "id": "fc422bf7-b873-49fc-a00e-ec550a3e9aa5",
  "createdBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "createdOn": 1688024863616,
  "lastModifiedBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "lastModifiedOn": 1688024863616
}

Retrieve a custom masking

get

Returns information about the custom masking with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the custom masking.

Responses

200

The custom masking with the specified ID.

application/json

namestringRequired

The name of the custom masking.

Example: myCustomHashing

idstring · uuidRequired

The ID of the masking.

Example: fc422bf7-b873-49fc-a00e-ec550a3e9aa5

createdBystring · uuidRequired

ID of the Collibra user who created this custom mapping.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

createdOninteger · int64Required

The timestamp of when this custom mapping was created

Example: 1688024863616

lastModifiedBystring · uuidRequired

ID of the Collibra user who last updated this custom mapping.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

lastModifiedOninteger · int64Required

The timestamp of when this custom mapping was last updated.

Example: 1688024863616

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

get/customMaskings/{id}

HTTPcURLJavaScriptPython

GET /rest/protect/v1/customMaskings/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "name": "myCustomHashing",
  "mappings": [
    {
      "provider": "Snowflake",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        },
        {
          "dataType": "number",
          "functionName": "hash_my_number"
        }
      ]
    },
    {
      "provider": "Databricks",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        }
      ]
    }
  ],
  "id": "fc422bf7-b873-49fc-a00e-ec550a3e9aa5",
  "createdBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "createdOn": 1688024863616,
  "lastModifiedBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "lastModifiedOn": 1688024863616
}

Delete a custom masking

delete

Deletes the custom masking with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the custom masking.

Responses

204

The custom masking has been deleted.

No content

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

delete/customMaskings/{id}

HTTPcURLJavaScriptPython

DELETE /rest/protect/v1/customMaskings/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Update a custom masking

patch

Updates the custom masking with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the custom masking.

Body

application/json

namestringOptional

The name of the custom masking.

Example: myCustomHashing

Responses

200

The custom masking has been updated.

application/json

namestringRequired

The name of the custom masking.

Example: myCustomHashing

idstring · uuidRequired

The ID of the masking.

Example: fc422bf7-b873-49fc-a00e-ec550a3e9aa5

createdBystring · uuidRequired

ID of the Collibra user who created this custom mapping.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

createdOninteger · int64Required

The timestamp of when this custom mapping was created

Example: 1688024863616

lastModifiedBystring · uuidRequired

ID of the Collibra user who last updated this custom mapping.

Example: 19d09600-73ee-4be9-bff3-5e99f5c074f6

lastModifiedOninteger · int64Required

The timestamp of when this custom mapping was last updated.

Example: 1688024863616

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

patch/customMaskings/{id}

HTTPcURLJavaScriptPython

PATCH /rest/protect/v1/customMaskings/{id} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": "myCustomHashing",
  "mappings": [
    {
      "provider": "Snowflake",
      "mappings": []
    }
  ]
}

{
  "name": "myCustomHashing",
  "mappings": [
    {
      "provider": "Snowflake",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        },
        {
          "dataType": "number",
          "functionName": "hash_my_number"
        }
      ]
    },
    {
      "provider": "Databricks",
      "mappings": [
        {
          "dataType": "string",
          "functionName": "hash_my_string"
        }
      ]
    }
  ],
  "id": "fc422bf7-b873-49fc-a00e-ec550a3e9aa5",
  "createdBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "createdOn": 1688024863616,
  "lastModifiedBy": "19d09600-73ee-4be9-bff3-5e99f5c074f6",
  "lastModifiedOn": 1688024863616
}