user-mgmt upsert-group

Use a JSON file to create a new user group or update an existing user group.

Syntax

cpd-cli user-mgmt upsert-group \
--from=<json-file-name> \
--profile=<cpd-profile-name> \
[--cpdconfig=<cpd-configuration-location>] \
[--replace-roles] \
[--verbose]

Arguments

The upsert-group 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.
--from A JSON file that describes the group details.
Status
Required.
Syntax
--from=<json-file-name>
Default value
No default.
Valid values
A valid *.json file name.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--replace-roles Replace roles for the existing group with new roles.
Status
Optional.
Syntax
--replace-roles
Default value
Not applicable.
Valid values
Not applicable.
--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.

Use a group.json file to create a user group or update an existing user group.
cpd-cli user-mgmt upsert-group \
--from=group.json \
--profile=${CPD_PROFILE_NAME}

Sample group.json file.

{
    "name": "Trial1",
    "description": "Upsert group test",
    "role_identifiers": ["cpd_developer_role", "wkc_data_scientist_role"]
}