list-users¶

Description¶

Lists users.

list-users is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-users
[--user-ids <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--user-ids (array)

The user IDs or CRNs of the users.

Syntax:

"string" "string" ...

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 100 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

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

users -> (array)

The users.

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

azureCloudIdentities -> (array)

The list of Azure cloud identities assigned to the 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 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.

nextToken -> (string)

The token to use when requesting the next set of results. If not present, there are no additional results.

Form Factors¶

public, private