user-mgmt list-users

Important: IBM Cloud Pak® for Data Version 4.6 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.6 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

List all Cloud Pak for Data users.

Syntax

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

Arguments

The list-users command has no arguments.

Options

Option Description
--cpdconfig The Cloud Pak for Data configuration location.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data 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 profile-name from the Cloud Pak for Data configuration.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
default
Valid values
Any valid profile name from the Cloud Pak for Data configuration.
--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.

Use a script to create environment variables with the correct values for your environment. For more information, see Best practice: Setting up install variables.

List all Cloud Pak for Data users in the default *.txt format.
cpd-cli user-mgmt list-users \
--profile=<cpd-configuration-profile-name>

Example *.txt output.

Username            UID                 Role                Display Name        Email  
---------           ------------        -------             ----------------    ---------------------- 
admin               1000330999          Admin               admin               --
user1               1000331001          User                user1               user1@company.com
List all Cloud Pak for Data users in *.json format.
cpd-cli user-mgmt list-users \
--profile=<cpd-configuration-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 Cloud Pak for Data users in the default *.csv format.
cpd-cli user-mgmt list-users \
--profile=<cpd-configuration-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