`config users set`

Important: IBM Cloud Pak® for Data Version 4.7 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.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Create a local user configuration.

Syntax

cpd-cli config users set <local-user-configuration-name> \
[--apikey=<api-key>] \
[--output=json|yaml|table] \
[--username=<cpd-user-name>]

Arguments

Argument	Description
`<local-user-configuration-name>`	The name of the local configuration to set for the user.

Table 1: Command arguments

Options

Option	Description
`--apikey`	Set the user API key. The Generate API key setting is available in the Cloud Pak for Data client's Profile and Settings page. Status Optional. Syntax `--apikey=<api-key>` Default value No default. Valid values A valid user API key.
`--help` `-h`	Display command help. Status Optional. Syntax `--help` Default value No default. Valid values Not applicable.
`--output`	Specify an output format. Valid formats include json, yaml, or table (the default format). Status Optional. Syntax `--output=json\|yaml\|table` Default value `table` Valid values `json\|yaml\|table`
`--username`	Specify a Cloud Pak for Data user name. Status Optional. Syntax `--username=<cpd-user-name>` Default value No default. Valid values A valid Cloud Pak for Data user name.

Table 2: Command options

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.

Create a local user configuration by pasting an API key.

cpd-cli config users set <local-user-configuration-name> \
--apikey=<api-key> \
--username=<cpd-user-name>