user-mgmt get-user

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.

Retrieve Cloud Pak for Data user details for the specified user name.

Syntax

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

Arguments

Table 1: Command arguments
Argument Description
<cpd-user-name> The name of the Cloud Pak for Data user to retrieve the details for.

Options

Table 2: Command 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 yaml or json (the default format).
Status
Optional.
Syntax
--output=json|yaml
Default value
json
Valid values
json|yaml
--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.

Retrieve Cloud Pak for Data user details for the specified user name.
cpd-cli user-mgmt get-user <cpd-user-name> \
--profile=<cpd-configuration-profile-name>
Example *json output.
{
  "approval_status": "approved",
  "authenticator": "default",
  "created_timestamp": 1612815298421,
  "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,
  "is_custom_picture": false,
  "last_modified_timestamp": 1612815298421,
  "misc": {},
  "permissions": [
    "sign_in_only"
  ],
  "profile_picture": "",
  "role": "User",
  "uid": "1000331001",
  "user_roles": [
    "zen_user_role"
  ],
  "username": "user1"
}