Skip to content

Create environment user.

Request

Security
ApiKeyAuth
Path
environmentIdstring, non-emptyrequired

The ID of the environment.

Bodyapplication/json

The parameters to create an environment user.

usernamestring, [ 1 .. 256 ] characters

Username of the OS.

Example:"oracle"
passwordstring, [ 1 .. 256 ] characters

Password of the OS.

Example:"oracle"
vaultstring, [ 1 .. 256 ] characters

The name or reference of the vault from which to read the host credentials.

Example:"my-vault"
vault_usernamestring, [ 1 .. 256 ] characters

Delphix display name for the vault user

Example:"my-vault-user"
hashicorp_vault_enginestring, [ 1 .. 256 ] characters

Vault engine name where the credential is stored.

Example:"kv"
hashicorp_vault_secret_pathstring, [ 1 .. 256 ] characters

Path in the vault engine where the credential is stored.

Example:"oracle-env"
hashicorp_vault_username_keystring, [ 1 .. 256 ] characters

Key for the username in the key-value store.

Example:"username"
hashicorp_vault_secret_keystring, [ 1 .. 256 ] characters

Key for the password in the key-value store.

Example:"secret"
cyberark_vault_query_stringstring, [ 1 .. 256 ] characters

Query to find a credential in the CyberArk vault.

Example:"Safe=Test;Folder=Test;Object=Test"
azure_vault_namestring, [ 1 .. 256 ] characters

Azure key vault name.

Example:"azure_vault"
azure_vault_username_keystring, [ 1 .. 256 ] characters

Azure vault key for the username in the key-value store.

Example:"username"
azure_vault_secret_keystring, [ 1 .. 256 ] characters

Azure vault key for the password in the key-value store.

Example:"secret"
use_kerberos_authenticationboolean

Whether to use kerberos authentication.

Example:true
use_engine_public_keyboolean

Whether to use public key authentication.

Example:true

This example can be used for creating a user with username and password.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2025.2.0.0/continuous-data-apis-dct-2025.2.0.0/environments/{environmentId}/users' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "username-1",
    "password": "password-1"
  }'

Responses

Environment user created

Bodyapplication/json
user_refstring

The reference of the created environment user

Example:"user-reference-1"
jobobject(Job)

An asynchronous task.

Response
{ "user_ref": "user-reference-1", "job": { "id": "job-123", "status": "RUNNING", "is_waiting_for_telemetry": true, "type": "DB_REFRESH", "localized_type": "DB Refresh", "error_details": "Unable to connect to the engine.", "warning_message": "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.", "target_id": "vdb-123", "target_name": "vdb", "start_time": "2022-01-02T05:11:24.148Z", "update_time": "2022-01-02T06:11:24.148Z", "trace_id": "string", "engine_ids": [ … ], "tags": [ … ], "engines": [ … ], "account_id": 1, "account_name": "User 1", "percent_complete": 50, "virtualization_tasks": [ … ], "tasks": [ … ], "execution_id": "string", "result_type": "string", "result": {} } }