create-external-users¶

Description¶

Create external users who are outside of the Cloudera ecosystem and will be able to access Data Shares.

Synopsis¶

  create-external-users
--datalake-crn <value>
--environment-crn <value>
--external-users <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--datalake-crn (string)

The CRN of the Data lake where the external users will be created.

--environment-crn (string)

The CRN of the Environment where the external users will be created.

--external-users (array)

List of external users to be created.

Shorthand Syntax:

email=string,username=string,companyName=string ... (separate items with spaces)

JSON Syntax:

[
  {
    "email": "string",
    "username": "string",
    "companyName": "string"
  }
  ...
]

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

item -> (object)

Details of an External user.

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.

secret -> (string)

The Secret of the external user that will be used for authentication to external services.

createdAt -> (datetime)

The date and time when the external user was created.

expiryTime -> (datetime)

The date and time when the external user will expire.

error -> (string)

Error message if any occurred during the creation of the external user.

Form Factors¶

public