config users set

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

Table 1: Command arguments
Argument Description
<local-user-configuration-name> The name of the local configuration to set for the user.

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.

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>