Skip to content
/
Log in to the Masking Eng...

Masking API (5.1.41)

Schema for the Continuous Compliance Engine API

Download OpenAPI description
CC Engine APIs (2025.1.0.0).json
CC Engine APIs (2025.1.0.0).yaml
Languages
Servers
Mock server
https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0
https://help-api.delphix.com/masking/api/v5.1.41

algorithm

Operations

logging

Operations

application

Operations

applicationSettings

Operations

asyncTask

Operations

billingUsage

Operations

classifier

Operations

columnMetadata

Operations

credentialPath

Operations

configuration

Operations

databaseConnector

Operations

databaseRuleset

Operations

domain

Operations

encryptionKey

Operations

environment

Operations

execution

Operations

executionComponent

Operations

executionEvent

Operations

sync

Operations

fileConnector

Operations

fileDownload

Operations

fileFieldMetadata

Operations

fileFormat

Operations

fileMetadata

Operations

fileRuleset

Operations

fileUpload

Operations

inventoryApproval

Operations

knowledgeBaseInfo

Operations

jdbcDriver

Operations

license

Operations

login

Operations

Log in to the Masking Engine

Request

Bodyapplication/jsonrequired

The login object

usernamestring<= 255 charactersrequired

The username for logging into the Masking Engine.

Example: "maskinguser"
passwordstring<= 255 charactersrequired

The password for logging into the Masking Engine.

Example: "secret123"
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "maskinguser",
    "password": "secret123"
  }'

Responses

Success

Bodyapplication/json
Authorizationstring

The Authorization token to be provided in the headers of subsequent endpoint calls. Note that the timeout for the Authorization token is controlled by the 'API_AUTHORIZATION_TIMEOUT' property.

Example: "415aac5d-SOME-RANDOM-STRING-af6cf70dc49e"
Response
application/json
{
  "Authorization": "415aac5d-SOME-RANDOM-STRING-af6cf70dc49e"
}

Log in to the Masking Engine with an OAuth2 access token from Data Control Tower.

Request

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/sso-login

Responses

Success

Bodyapplication/json
Authorizationstring

The Authorization token to be provided in the headers of subsequent endpoint calls. Note that the timeout for the Authorization token is controlled by the 'API_AUTHORIZATION_TIMEOUT' property.

Example: "415aac5d-SOME-RANDOM-STRING-af6cf70dc49e"
Response
application/json
{
  "Authorization": "415aac5d-SOME-RANDOM-STRING-af6cf70dc49e"
}

Log in to the Masking Engine with an OAuth2 access token from a customer's Authorization Server.

Request

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/oauth2-login

Responses

Success

Bodyapplication/json
Authorizationstring

The Authorization token to be provided in the headers of subsequent endpoint calls. Note that the timeout for the Authorization token is controlled by the 'API_AUTHORIZATION_TIMEOUT' property.

Example: "415aac5d-SOME-RANDOM-STRING-af6cf70dc49e"
Response
application/json
{
  "Authorization": "415aac5d-SOME-RANDOM-STRING-af6cf70dc49e"
}

Log out of the Masking Engine

Request

Security
api_key
curl -i -X PUT \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.1.0.0/cc-engine-apis-2025.1.0.0/logout \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

mainframeDatasetConnector

Operations

mainframeDatasetFieldMetadata

Operations

mainframeDatasetFormat

Operations

mainframeDatasetMetadata

Operations

mainframeDatasetRecordType

Operations

mainframeDatasetRuleset

Operations

mappingAlgorithm

Operations

maskingJob

Operations

monitoring

Operations

mountFilesystem

Operations

nonConformantDataSample

Operations

passwordVault

Operations

plugin

Operations

profileJob

Operations

profileSet

Operations

profileResultDatabase

Operations

profileResultFile

Operations

profileResultMainframe

Operations

recordType

Operations

recordTypeQualifier

Operations

reidentificationJob

Operations

role

Operations

sshKey

Operations

supportBundle

Operations

systemInformation

Operations

tableMetadata

Operations

tokenizationJob

Operations

user

Operations