credentials update
Command: boundary credentials update
The credentials update
command lets you update Boundary credential resources.
Examples
The following example updates an existing user password credential with a new password:
Example output:
Usage
Command options
-description
(string: "")
- A description to set on the credential.-id
(string: "")
- The ID of the credential to update.-name
(string: "")
- A name to set on the credential.-version
(int: 0)
- The version of the credential to update. If you don't specify a version, the command performs a check-and-set automatically.
Usages by type
The available types are json
, ssh-private-key
, and username-password
.
The credentials update json
command lets you update a JSON credential.
Example
The following example updates a JSON credential with the ID csst_1234567890
:
Usage
JSON object credential options
The following options are specific to JSON credentials in addition to the command options:
-bool-kv
(map: {})
– A key=value Boolean value to add to the request's object map. You can specify this option multiple times. This value can be a reference to a file on disk (file://
) or an environment variable (env://
) from which Boundary reads the value.-kv
(map: {})
– A key=value pair to add to the request's object map. This option can also be a key value only which will set a JSON null as the value. If you provide a value, Boundary automatically infers the type. Use-string-kv
,-bool-kv
, or-num-kv
to override the type. You can specify this option multiple times. This value can be a reference to a file on disk (file://
) or an environment variable (env://
) from which Boundary reads the value.-num-kv
(map: {})
– A key=value numeric value to add to the request's object map. You can specify this option multiple times. This value can be a reference to a file on disk (file://
) or an environment variable (env://
) from which Boundary reads the value.-object
(string: "")
- A JSON map value to use as the entirety of the request's object map. Usually this is sourced from a file usingfile://
syntax. This option is exclusive with the other kv flags.-string-kv
(map: {})
– A key=value string value to add to the request's object map. You can specify this option multiple times. This value can be a reference to a file on disk (file://
) or an environment variable (env://
) from which Boundary reads the value.
CLI options
In addition to the command specific options, there are options common to all CLI commands and subcommands: