create-machine-user¶

Description¶

Creates a machine user in the account. A machine user can be used to access CDP API. A machine user can have access keys associated with it and can be assigned roles and resource roles. A machine user cannot login to the CDP console.

Synopsis¶

  create-machine-user
--machine-user-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--machine-user-name (string)

The name to use for the new machine user. The name must be an alpha numeric string, including ‘-‘ and ‘_’, cannot start with ‘__’ (double underscore) and cannot be longer than 128 characters. Only one machine user with this name can exist in an account at a given time.

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

machineUser -> (object)

Information about a Cloudera CDP machine user.

machineUserName -> (string)

The machine user name.

crn -> (string)

The CRN of the user.

creationDate -> (datetime)

The date when this machine user record was created.

workloadUsername -> (string)

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

azureCloudIdentities -> (array)

The list of Azure cloud identities assigned to the machine user.

item -> (object)

An Azure cloud identity.

objectId -> (string)

The Azure object ID (OID).

environmentCrn -> (string)

The CRN of the environment this Azure cloud identity is associated with. If omitted, this cloud identity is associated with all Azure environments.

status -> (string)

The current status of the machine user. The possible status values are ACTIVE and CONTROL_PLANE_LOCKED_OUT. ACTIVE indicates that the machine user is active in CDP. An active machine user can authenticate to the CDP control plane and workload clusters. CONTROL_PLANE_LOCKED_OUT indicates that the machine user is locked out of the CDP control plane. The locked-out machine user can no longer authenticate to the control plane but can authenticate 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