Create a new Account

Request

Security

ApiKeyAuth

Bodyapplication/jsonrequired

is_adminboolean

Whether the created account must be granted to admin role.

Default:false

generate_api_keyboolean

Whether an API key must be generated for this Account. This must be set if the Account will be used for API key based authentication, and unset otherwise.

Default:false

api_client_idstring, [ 1 .. 1024 ] characters

The unique ID which is used to identify the identity of an API request. The web server (nginx) configuration must be configured so as to include the external ID as the value of the X_CLIENT_ID HTTP request header when requests are proxied. If this value isn't set, the application will automatically generate one. For OAuth2/JWT based authentication, this typically corresponds to a value extracted from the JWT, uniquely identifying the Account.

first_namestring, [ 1 .. 1024 ] characters

An optional first name for the Account.

last_namestring, [ 1 .. 1024 ] characters

An optional last name for the Account.

emailstring, [ 1 .. 1024 ] characters

An optional email for the Account.

usernamestring, [ 1 .. 1024 ] characters

The username for username/password authentication. This can also be used to provide an optional logical name for the Account.

passwordstring, [ 1 .. 1024 ] characters

The password for username/password authentication.

ldap_principalstring, [ 1 .. 1024 ] characters

This value will be used for linking this account to an LDAP user when authenticated with the same LDAP principal. When accounts authenticate with LDAP, an LDAP principal value is calculated based on the username, msad_domain_name, search_base and username_pattern.

tagsArray of objects(Tag)

The tags to be created for this Account.

Example:

[
  {
    "key": "key-1",
    "value": "value-1"
  },
  {
    "key": "key-2",
    "value": "value-2"
  }
]

curl -i -X POST \
  https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/management/accounts \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_admin": false,
    "generate_api_key": false,
    "api_client_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "username": "string",
    "password": "string",
    "ldap_principal": "string",
    "tags": [
      {
        "key": "key-1",
        "value": "value-1"
      },
      {
        "key": "key-2",
        "value": "value-2"
      }
    ]
  }'

Responses

The created Account id and if requested the generated API key token.

Bodyapplication/json

tokenstring

The opaque token to use to authenticate for other API calls. The token must be included in all HTTP API calls in a request header named "Authorization", and prefixed with "apk " to denote that it is a proprietary API key format. For instance, if the token is "abc123", request must contain the following HTTP request header: "Authorization: apk abc123".

idinteger, (int64)

Numeric ID of the created Account.

first_namestring, [ 1 .. 1024 ] characters

First name of the created Account.

last_namestring, [ 1 .. 1024 ] characters

Last name of the created Account.

emailstring, [ 1 .. 1024 ] characters

Email of the created Account.

usernamestring, [ 1 .. 1024 ] characters

Username of the created Account.

ldap_principalstring, [ 1 .. 1024 ] characters

The LDAP principal of the created Account.

tagsArray of objects(Tag)

The tags to be created for this Account.

Example:

[
  {
    "key": "key-1",
    "value": "value-1"
  },
  {
    "key": "key-2",
    "value": "value-2"
  }
]

Response

{
  "token": "string",
  "id": 0,
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "username": "string",
  "ldap_principal": "string",
  "tags": [
    { … },
    { … }
  ]
}