list-external-users¶

Description¶

List external users registered in Cloudera, who are outside of the Cloudera ecosystem.

list-external-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-external-users
--datalake-crn <value>
--environment-crn <value>
[--search-term <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--datalake-crn (string)

The CRN of the Data Lake where the external users need to be listed.

--environment-crn (string)

The CRN of the Environment where the external users need to be listed.

--search-term (string)

A search term to filter the external users by username or email or companyName.

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

externalUsers -> (array)

List of external users.

item -> (object)

Details of an external user in a list response.

userId -> (integer)

The unique identifier of the external user.

username -> (string)

The username of the external user.

email -> (string)

The email address of the external user.

companyName -> (string)

The company name of the external user.

clientId -> (string)

The Client ID of the external user that will be used for authentication.

createdAt -> (datetime)

The date and time when the external user was created.

isActive -> (boolean)

Indicates whether the external user’s credentials are revoked or not.

nextToken -> (string)

The token to use when requesting the next set of results. If there are no additional results, the string is empty.

Form Factors¶

public