user-mgmt get-group

Retrieve Cloud Pak for Data group details for the specified group.

Syntax

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

Arguments

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

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.
--include-members Include members from the group API call.
Status
Optional.
Syntax
--include-members
Default value
Not applicable.
Valid values
Not applicable.

--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 details on a Cloud Pak for Data user group.
cpd-cli user-mgmt get-group <cpd-user-group-name> \
--profile=<cpd-configuration-profile-name>
Example *.json output.
{
  "created_at": "2022-09-22T21:36:26.946Z",
  "created_by": "admin",
  "description": "",
  "group_id": 10001,
  "misc": {},
  "name": "test",
  "roles": [
    {
      "role_id": "zen_administrator_role",
      "role_name": "Administrator"
    }
  ],
  "updated_at": "2021-09-22T21:36:26.946Z"
}