user-mgmt list-users

List all IBM Software Hub users.

Syntax

cpd-cli user-mgmt list-users \
--profile=<profile-name> \
[--cpdconfig=<cpd-configuration-location>] \
[--output=json|yaml|csv|text] \
[--verbose]

Arguments

The list-users command has no arguments.

Options

Table 1: Command options
Option Description
--cpdconfig The IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM® Software Hub configuration location.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.

--output

-o

 Specify an output format. Valid formats include JSON, YAML, CSV, or text (the default format).
Status
Optional.
Syntax
--output=json|yaml|csv|text
Default value
text
Valid values
json|yaml|csv|text
--profile The name of the profile that you created to store information about an instance of IBM Software Hub and your credentials for the instance.
Status
Required.
Syntax
--profile=<profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For more information, see Setting up installation environment variables.

List all IBM Software Hub users in the default *.txt format.
cpd-cli user-mgmt list-users \
--profile=${CPD_PROFILE_NAME}

Example *.txt output.

Username            UID                 Role                Display Name        Email  
---------           ------------        -------             ----------------    ---------------------- 
admin               1000330999          Admin               admin               --
user1               1000331001          User                user1               user1@company.com
List all IBM Software Hub users in *.json format.
cpd-cli user-mgmt list-users \
--profile=${CPD_PROFILE_NAME} \
--output=json

Example *.json output.

[
  {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": 1612510966035,
    "current_account_status": "enabled",
    "deletable": false,
    "displayName": "admin",
    "email": "--",
    "group_roles": [],
    "groups": [
      {
        "created_at": "",
        "created_by": "Cloud Pak for Data",
        "description": "All users are implicitly part of this group",
        "group_id": 10000,
        "misc": {},
        "name": "All users",
        "updated_at": ""
      }
    ],
    "internal_user": false,
    "last_modified_timestamp": 1612544911724,
    "misc": {},
    "permissions": [
      "administrator",
      "can_provision",
      "manage_catalog",
      "access_catalog"
    ],
    "role": "Admin",
    "uid": "1000330999",
    "user_roles": [
      "zen_administrator_role",
      "zen_developer_role",
      "wkc_data_scientist_role"
    ],
    "username": "admin"
  },
  {
    "approval_status": "approved",
    "authenticator": "default",
    "created_timestamp": 1612565878245,
    "current_account_status": "enabled",
    "deletable": true,
    "displayName": "user1",
    "email": "user1@company.com",
    "group_roles": [],
    "groups": [
      {
        "created_at": "",
        "created_by": "Cloud Pak for Data",
        "description": "All users are implicitly part of this group",
        "group_id": 10000,
        "misc": {},
        "name": "All users",
        "updated_at": ""
      }
    ],
    "internal_user": false,
    "last_modified_timestamp": 1612565878245,
    "misc": {},
    "permissions": [
      "access_catalog",
      "can_provision",
      "sign_in_only"
    ],
    "role": "User",
    "uid": "1000331001",
    "user_roles": [
      "zen_developer_role",
      "zen_user_role"
    ],
    "username": "user1"
  }
]
List all IBM Software Hub users in the default *.csv format.
cpd-cli user-mgmt list-users \
--profile=${CPD_PROFILE_NAME} \
--output=csv

Example *.csv output.

username,password,email,displayName,user_roles
admin,,,admin,zen_administrator_role
user1,,user1@company.com,user1,zen_administrator_role
user2,,user2@company.com,user2,zen_administrator_role;zen_user_role