list-users¶

Description¶

Lists the users who have access to the cluster.

Synopsis¶

  list-users
--cluster-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cluster-id (string)

The ID of the cluster for which the users must be retrieved.

--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 list of users allowed to access the given cluster.

item -> (object)

Cloud user definition object.

userId -> (string)

A cloud based unique identifier of the user (ARN for AWS users, groupId for Azure users).

Form Factors¶

public, private