user-mgmt bulk-upsert-users

Add or update multiple Cloud Pak for Data users.

Syntax

cpd-cli user-mgmt bulk-upsert-users \
--from-csv-file=<csv-file-name> \
--from-json-file=<json-file-name> \
--profile=<cpd-profile-name> \
[--cpdconfig=<cpd-configuration-location>] \
[--verbose]

Arguments

The bulk-upsert-users command has no arguments.

Options

Table 1: Command 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.
--from-csv-file A comma-separated (CSV) file that describes the user details.
Status
Required.
Syntax
--from-csv-file=<csv-file-name>
Default value
No default.
Valid values
A valid *.csv file name.
--from-json-file A JSON file that describes the user details.
Status
Required.
Syntax
--from-json-file=<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.
--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.

Add or update multiple Cloud Pak for Data users with parameters from a bulkUsers.csv file.
cpd-cli user-mgmt bulk-upsert-users \
--from-csv-file=bulkUsers.csv \
--cpdconfig=<cpd-configuration-location> \
--profile=${CPD_PROFILE_NAME}

Sample bulkUsers.csv file.

username,password,email,displayName,user_roles
tim,pass,tim@ibm.com,timothee,zen_administrator_role;cpd_user_role
keshav999,pass,k@ibm.com:wq,Keshav,cpd_user_role
monil99,past,monil@ibm.com,Monil,
Tom,12345,tom@test.com,Tim,cpd_administrator_role cpd_user_role
Add or update multiple Cloud Pak for Data users with parameters from a bulkUsers.json file.
cpd-cli user-mgmt bulk-upsert-users \
--from-json-file=bulkUsers.json \
--cpdconfig=<cpd-configuration-location> \
--profile=${CPD_PROFILE_NAME}

Sample bulkUsers.json file.

[
   {
      "username":"J9",
      "password":"12345",
      "email":"tom@test.com",
      "displayName":"Tim",
      "user_roles":[
         "cpd_user_role"
      ]
   },
   {
      "username":"K99",
      "password":"12345",
      "email":"tom@test.com",
      "displayName":"Tim",
      "user_roles":[
         "cpd_user_role"
      ]
   },
   {
      "username":"L9",
      "password":"12345",
      "email":"tom@test.com",
      "displayName":"Tim",
      "user_roles":[
         "cpd_user_role"
      ]
   },
   {
      "username":"M9",
      "password":"12345",
      "email":"tom@test.com",
      "displayName":"Tim",
      "user_roles":[
         "cpd_user_role"
      ]
   },
   {
      "username":"To9",
      "password":"12345",
      "email":"tom@test.com",
      "displayName":"Tim",
      "user_roles":[
         "cpd_administrator_role"
      ]
   },
   {
      "username":"Th8",
      "password":"12345",
      "email":"tom@test.com",
      "displayName":"Tim",
      "user_roles":[
         "cpd_user_role"
      ]
   },
   {
      "username":"That9",
      "password":"12345",
      "email":"tom@test.com",
      "displayName":"Tim",
      "user_roles":[
         "cpd_user_role"
      ]
   }
]