Skip to content
/
Get all users

Masking API (5.1.43)

Schema for the Continuous Compliance Engine API

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

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

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

Get all users

Request

Security
api_key
Query
page_numberinteger(int64)

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

Default 1
page_sizeinteger(int64)

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

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/users?page_number=1&page_size=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
_pageInfoobject(PageInfo)
responseListArray of objects(User)
Example: [{"userName":"DelphixUser1","password":"Password_123","firstName":"First","lastName":"Last","email":"user@delphix.com","isAdmin":false,"showWelcome":true,"userStatus":"ACTIVE","nonAdminProperties":{"roleId":1,"environmentIds":[1,3,7]}}]
Response
application/json
{
  "_pageInfo": {
    "numberOnPage": 0,
    "total": 0
  },
  "responseList": [
    { … }
  ]
}

Create user

Request

Security
api_key
Bodyapplication/jsonrequired

The user to create

userNamestring<= 255 charactersrequired

The name for this User. Note that it must be unique among Users.

Example: "DelphixUser1"
passwordstring

The password for this User. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Password_123"
firstNamestring<= 255 charactersrequired

The first name of this User. This does not need to match the user name.

Example: "First"
lastNamestring<= 255 charactersrequired

The last name of this User. This does not need to match the user name.

Example: "Last"
emailstring<= 255 charactersrequired

The email address for this User.

Example: "user@delphix.com"
isAdminbooleanrequired

True for an administrative User, false for a non-administrative User.

showWelcomeboolean

Flag to enable and disable welcome page for user, default true for a newly created User.

Default true
Example: true
userStatusstringrequired

Status of user account.

Enum"ACTIVE""LOCKED""DISABLED"
Example: "ACTIVE"
disableReasonstring<= 255 characters

The reason why the user's account was locked.

nonAdminPropertiesobject(NonAdminProperties)
Example: {"roleId":1,"environmentIds":[1,3,7]}
apiAccessboolean

For use with SSO only. Flag to enable and disable api access for users. When SSO is enabled, the value defaults to true for admins and false for non-admins. When SSO is disabled, the value defaults to true for all users. The value is only modifiable when SSO is enabled and only by admins. The value is immutable for admin users except with DCT enabled. When SSO is disabled, the value is ignored and the user will be granted API access.

principalstring

Identifies this user on external identity services. Used for OAuth2 API authentication when the principal is selected as the field to match users with access tokens.

curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/users \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userName": "DelphixUser1",
    "password": "Password_123",
    "firstName": "First",
    "lastName": "Last",
    "email": "user@delphix.com",
    "isAdmin": false,
    "showWelcome": true,
    "userStatus": "ACTIVE",
    "nonAdminProperties": {
      "roleId": 1,
      "environmentIds": [
        1,
        3,
        7
      ]
    }
  }'

Responses

Success

Bodyapplication/json
userIdinteger(int32)read-only

The ID of the User. This field will be generated by the Masking Engine.

userNamestring<= 255 charactersrequired

The name for this User. Note that it must be unique among Users.

Example: "DelphixUser1"
passwordstring

The password for this User. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Password_123"
firstNamestring<= 255 charactersrequired

The first name of this User. This does not need to match the user name.

Example: "First"
lastNamestring<= 255 charactersrequired

The last name of this User. This does not need to match the user name.

Example: "Last"
emailstring<= 255 charactersrequired

The email address for this User.

Example: "user@delphix.com"
isAdminbooleanrequired

True for an administrative User, false for a non-administrative User.

showWelcomeboolean

Flag to enable and disable welcome page for user, default true for a newly created User.

Default true
Example: true
userStatusstringrequired

Status of user account.

Enum"ACTIVE""LOCKED""DISABLED"
Example: "ACTIVE"
disableReasonstring<= 255 characters

The reason why the user's account was locked.

nonAdminPropertiesobject(NonAdminProperties)
Example: {"roleId":1,"environmentIds":[1,3,7]}
apiAccessboolean

For use with SSO only. Flag to enable and disable api access for users. When SSO is enabled, the value defaults to true for admins and false for non-admins. When SSO is disabled, the value defaults to true for all users. The value is only modifiable when SSO is enabled and only by admins. The value is immutable for admin users except with DCT enabled. When SSO is disabled, the value is ignored and the user will be granted API access.

principalstring

Identifies this user on external identity services. Used for OAuth2 API authentication when the principal is selected as the field to match users with access tokens.

Response
application/json
{
  "userName": "DelphixUser1",
  "password": "Password_123",
  "firstName": "First",
  "lastName": "Last",
  "email": "user@delphix.com",
  "isAdmin": false,
  "showWelcome": true,
  "userStatus": "ACTIVE",
  "nonAdminProperties": {
    "roleId": 1,
    "environmentIds": [ … ]
  }
}

Get user by ID

Request

Security
api_key
Path
userIdinteger(int32)required

The ID of the user to get

curl -i -X GET \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
userIdinteger(int32)read-only

The ID of the User. This field will be generated by the Masking Engine.

userNamestring<= 255 charactersrequired

The name for this User. Note that it must be unique among Users.

Example: "DelphixUser1"
passwordstring

The password for this User. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Password_123"
firstNamestring<= 255 charactersrequired

The first name of this User. This does not need to match the user name.

Example: "First"
lastNamestring<= 255 charactersrequired

The last name of this User. This does not need to match the user name.

Example: "Last"
emailstring<= 255 charactersrequired

The email address for this User.

Example: "user@delphix.com"
isAdminbooleanrequired

True for an administrative User, false for a non-administrative User.

showWelcomeboolean

Flag to enable and disable welcome page for user, default true for a newly created User.

Default true
Example: true
userStatusstringrequired

Status of user account.

Enum"ACTIVE""LOCKED""DISABLED"
Example: "ACTIVE"
disableReasonstring<= 255 characters

The reason why the user's account was locked.

nonAdminPropertiesobject(NonAdminProperties)
Example: {"roleId":1,"environmentIds":[1,3,7]}
apiAccessboolean

For use with SSO only. Flag to enable and disable api access for users. When SSO is enabled, the value defaults to true for admins and false for non-admins. When SSO is disabled, the value defaults to true for all users. The value is only modifiable when SSO is enabled and only by admins. The value is immutable for admin users except with DCT enabled. When SSO is disabled, the value is ignored and the user will be granted API access.

principalstring

Identifies this user on external identity services. Used for OAuth2 API authentication when the principal is selected as the field to match users with access tokens.

Response
application/json
{
  "userName": "DelphixUser1",
  "password": "Password_123",
  "firstName": "First",
  "lastName": "Last",
  "email": "user@delphix.com",
  "isAdmin": false,
  "showWelcome": true,
  "userStatus": "ACTIVE",
  "nonAdminProperties": {
    "roleId": 1,
    "environmentIds": [ … ]
  }
}

Update user by ID

Request

Security
api_key
Path
userIdinteger(int32)required

The ID of the user to update

Bodyapplication/jsonrequired

The updated user

userNamestring<= 255 charactersrequired

The name for this User. Note that it must be unique among Users.

Example: "DelphixUser1"
passwordstring

The password for this User. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Password_123"
firstNamestring<= 255 charactersrequired

The first name of this User. This does not need to match the user name.

Example: "First"
lastNamestring<= 255 charactersrequired

The last name of this User. This does not need to match the user name.

Example: "Last"
emailstring<= 255 charactersrequired

The email address for this User.

Example: "user@delphix.com"
isAdminbooleanrequired

True for an administrative User, false for a non-administrative User.

showWelcomeboolean

Flag to enable and disable welcome page for user, default true for a newly created User.

Default true
Example: true
userStatusstringrequired

Status of user account.

Enum"ACTIVE""LOCKED""DISABLED"
Example: "ACTIVE"
disableReasonstring<= 255 characters

The reason why the user's account was locked.

nonAdminPropertiesobject(NonAdminProperties)
Example: {"roleId":1,"environmentIds":[1,3,7]}
apiAccessboolean

For use with SSO only. Flag to enable and disable api access for users. When SSO is enabled, the value defaults to true for admins and false for non-admins. When SSO is disabled, the value defaults to true for all users. The value is only modifiable when SSO is enabled and only by admins. The value is immutable for admin users except with DCT enabled. When SSO is disabled, the value is ignored and the user will be granted API access.

principalstring

Identifies this user on external identity services. Used for OAuth2 API authentication when the principal is selected as the field to match users with access tokens.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userName": "DelphixUser1",
    "password": "Password_123",
    "firstName": "First",
    "lastName": "Last",
    "email": "user@delphix.com",
    "isAdmin": false,
    "showWelcome": true,
    "userStatus": "ACTIVE",
    "nonAdminProperties": {
      "roleId": 1,
      "environmentIds": [
        1,
        3,
        7
      ]
    }
  }'

Responses

Success

Bodyapplication/json
userIdinteger(int32)read-only

The ID of the User. This field will be generated by the Masking Engine.

userNamestring<= 255 charactersrequired

The name for this User. Note that it must be unique among Users.

Example: "DelphixUser1"
passwordstring

The password for this User. NOTE: For updates, this field does not have to be set. If no password is provided on an update, then the current password will persist.

Example: "Password_123"
firstNamestring<= 255 charactersrequired

The first name of this User. This does not need to match the user name.

Example: "First"
lastNamestring<= 255 charactersrequired

The last name of this User. This does not need to match the user name.

Example: "Last"
emailstring<= 255 charactersrequired

The email address for this User.

Example: "user@delphix.com"
isAdminbooleanrequired

True for an administrative User, false for a non-administrative User.

showWelcomeboolean

Flag to enable and disable welcome page for user, default true for a newly created User.

Default true
Example: true
userStatusstringrequired

Status of user account.

Enum"ACTIVE""LOCKED""DISABLED"
Example: "ACTIVE"
disableReasonstring<= 255 characters

The reason why the user's account was locked.

nonAdminPropertiesobject(NonAdminProperties)
Example: {"roleId":1,"environmentIds":[1,3,7]}
apiAccessboolean

For use with SSO only. Flag to enable and disable api access for users. When SSO is enabled, the value defaults to true for admins and false for non-admins. When SSO is disabled, the value defaults to true for all users. The value is only modifiable when SSO is enabled and only by admins. The value is immutable for admin users except with DCT enabled. When SSO is disabled, the value is ignored and the user will be granted API access.

principalstring

Identifies this user on external identity services. Used for OAuth2 API authentication when the principal is selected as the field to match users with access tokens.

Response
application/json
{
  "userName": "DelphixUser1",
  "password": "Password_123",
  "firstName": "First",
  "lastName": "Last",
  "email": "user@delphix.com",
  "isAdmin": false,
  "showWelcome": true,
  "userStatus": "ACTIVE",
  "nonAdminProperties": {
    "roleId": 1,
    "environmentIds": [ … ]
  }
}

Delete user by ID

Request

Security
api_key
Path
userIdinteger(int32)required

The ID of the user to delete

curl -i -X DELETE \
  'https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Send Reset password mail to the user

Request

Security
api_key
Bodyapplication/jsonrequired

The username for which password has to be reset

userNamestring<= 255 charactersrequired

The username for logging into the Masking Engine.

Example: "maskinguser"
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/users/forgot-password \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userName": "maskinguser"
  }'

Responses

Password reset email sent!

Reset new password for the user

Request

Security
api_key
Bodyapplication/jsonrequired

Reset password for user using token received on e-mail

userNamestring<= 255 charactersrequired

The username for resetting the password

Example: "maskinguser"
tokenstring<= 255 charactersrequired

The generated token received in the email

Example: "abc"
passwordstring<= 255 charactersrequired

The new password for this username.

Example: "Secret123!"
curl -i -X POST \
  https://help-api.delphix.com/_mock/continuous-compliance-engine/2025.3.0.0/cc-engine-apis-2025.3.0.0/users/reset-password \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userName": "maskinguser",
    "token": "abc",
    "password": "Secret123!"
  }'

Responses

Password successfully updated!