update-user¶

Description¶

Updates a user. Updates request fields provided. An error is returned if no field updates are defined in the request.

Synopsis¶

  update-user
--user <value>
[--active | --no-active]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--user (string)

The CRN or userId of the user to be updated.

--active | --no-active (boolean)

The active state to which to set the user. When it is ‘true’, the user will be activated. When it is ‘false’ the user will be deactivated.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

user -> (object)

Information about a Cloudera CDP user.

userId -> (string)

The stable, unique identifier of the user.

crn -> (string)

The CRN of the user.

email -> (string)

The user’s email address.

firstName -> (string)

The user’s first name.

lastName -> (string)

The user’s last name.

creationDate -> (datetime)

The date when this user record was created.

accountAdmin -> (boolean)

Whether the user is an administrator of their CDP account.

identityProviderCrn -> (string)

The identity provider that the user belongs to. It can be “Cloudera-Default”, “Cloudera-Administration”, or a customer defined IdP.

lastInteractiveLogin -> (datetime)

The date of the user’s last interactive login.

workloadUsername -> (string)

The username used in all the workload clusters of the user.

status -> (string)

The current status of the user. The possible status values are ACTIVE, CONTROL_PLANE_LOCKED_OUT, and DEACTIVATED. ACTIVE indicates that the user is active in CDP. An active user can authenticate to the CDP control plane and workload clusters. CONTROL_PLANE_LOCKED_OUT indicates that the user is locked out of the CDP control plane. The locked-out user can no longer authenticate to the control plane but can authenticate to the workload clusters. DEACTIVATED indicates that the user is deactivated in CDP. A deactivated user can neither authenticate to the control plane nor to the workload clusters. Note that more statuses could be added in the future. The statuses other than ACTIVE are only returned on Cloudera for Government.

workloadPasswordDetails -> (object)

Information about the workload password for a user or machine user.

isPasswordSet -> (boolean)

Whether a workload password is set.

passwordExpirationDate -> (datetime)

The date at which the workload password will expire.

passwordMinLifetimeDate -> (datetime)

The minimum lifetime date of the workload password. A new password can’t be set until this date.

Form Factors¶

public, private