Update an Account

Request

Security

ApiKeyAuth

Path

idinteger, (int64)required

Numeric ID of the Account.

Bodyapplication/jsonrequired

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. 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.

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.

curl -i -X PUT \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/23.0.0/continuous-data-apis-dct-23.0.0/management/accounts/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_client_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "username": "string",
    "ldap_principal": "string"
  }'

Responses

Returns the updated Account.

Bodyapplication/json

idinteger, (int64)read-only

Numeric ID of the Account.

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. 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.

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.

last_access_timestring, (date-time)

last time this account made a (successful or failed) API call. Note that updates to this property are asynchronous and make take some time to be reflected.

creation_timestring, (date-time)

Creation time of this Account. This value is null for accounts created prior to version 9.0.0 of the product.

api_key_expiry_timestring, (date-time)

Expiration time of the API key, if null then API key will never expire.

effective_scopesArray of objects(EffectiveScope)

Access group scopes associated with this 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"
  }
]

enabledboolean

Whether this account can be used to make API calls.

Response

{
  "id": 0,
  "api_client_id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "username": "string",
  "ldap_principal": "string",
  "last_access_time": "2019-08-24T14:15:22Z",
  "creation_time": "2019-08-24T14:15:22Z",
  "api_key_expiry_time": "2019-08-24T14:15:22Z",
  "effective_scopes": [
    { … }
  ],
  "tags": [
    { … },
    { … }
  ],
  "enabled": true
}