user-mgmt upsert-user

Important: IBM Cloud Pak® for Data Version 4.8 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.8 reaches end of support. For more information, see Upgrading from IBM Cloud Pak for Data Version 4.8 to IBM Software Hub Version 5.1.

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

Syntax

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

Arguments

The upsert-user command has no arguments.

Options

Option Description
--cpdconfig The Cloud Pak for Data
 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 Cloud Pak for Data configuration location.
--data The JSON file name that describes user details.
Status
Required.
Syntax
--data=<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.

Table 1: Command options

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 Best practice: Setting up installation environment variables.

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

Sample user.json file.

{
   "username":"user1",
   "displayName":"user1",
   "email":"user1@company.com",
   "user_roles":[
      "cpd_user_role"
   ],
   "password":"password"
}