Credentials Commands
The credentials command group manages Credentials — named secrets (passwords, SSH keys, PGP keys, X.509 certificates, and key pairs) used by Accounts, Endpoints, and Pipelines for authentication and encryption.
For command line syntax, see the UDMG Client CLI overview.
The create and update commands each dispatch to a type-specific subcommand that matches the kind of secret being stored.
Commands Overview
| Command | Description | Required Role |
|---|---|---|
credentials list | Returns all Credentials. | Any |
credentials get <name> | Retrieves the full definition of a Credential identified by name. | Any |
credentials delete <name> | Permanently deletes a Credential. |
|
credentials create | Creates a Credential. A type subcommand must be specified to identify the kind of secret being stored. | |
credentials create auth-password | Creates an auth-password Credential storing a username/password pair. |
|
credentials create auth-key | Creates an auth-key Credential storing a username with an SSH private key. |
|
credentials create auth-password-key | Creates an auth-password-key Credential storing a username, password, and SSH private key. |
|
credentials create key-pair | Creates a key-pair Credential storing a symmetric key/value pair. |
|
credentials create ssh-private-key | Creates an ssh-private-key Credential storing an SSH private key. |
|
credentials create ssh-public-key | Creates an ssh-public-key Credential storing an SSH public key. |
|
credentials create pgp-private-key | Creates a pgp-private-key Credential storing a PGP private key. |
|
credentials create pgp-public-key | Creates a pgp-public-key Credential storing a PGP public key. |
|
credentials create x509-cert | Creates an x509-cert Credential storing an X.509 certificate. |
|
credentials create x509-private-key | Creates an x509-private-key Credential storing an X.509 private key. |
|
credentials create x509-cert-key | Creates an x509-cert-key Credential storing an X.509 certificate with its matching private key. |
|
credentials update | Updates a Credential. A type subcommand must be specified, followed by the name of the Credential to update. | |
credentials update auth-password <name> | Updates an auth-password Credential. |
|
credentials update auth-key <name> | Updates an auth-key Credential. |
|
credentials update auth-password-key <name> | Updates an auth-password-key Credential. |
|
credentials update key-pair <name> | Updates a key-pair Credential. |
|
credentials update ssh-private-key <name> | Updates an ssh-private-key Credential. |
|
credentials update ssh-public-key <name> | Updates an ssh-public-key Credential. |
|
credentials update pgp-private-key <name> | Updates a pgp-private-key Credential. |
|
credentials update pgp-public-key <name> | Updates a pgp-public-key Credential. |
|
credentials update x509-cert <name> | Updates an x509-cert Credential. |
|
credentials update x509-private-key <name> | Updates an x509-private-key Credential. |
|
credentials update x509-cert-key <name> | Updates an x509-cert-key Credential. |
|
credentials enable <name> | Enables a Credential. |
|
credentials disable <name> | Disables a Credential. |
|
credentials details <name> | Returns parsed details of the specified Credential, such as key fingerprints, certificate subject and expiry, and algorithm information, without returning the raw secret value. | Any |
credentials reveal <name> | Returns the decrypted secret value of the specified Credential. The response contains the plaintext secret. |
|
credentials assignments <name> | Returns all resources (Accounts, Endpoints, Pipelines, Tasks, and Domains) that currently reference the specified Credential. | Any |
Authentication
Every udmg-client command authenticates to the UDMG Server using a UDMG username and password. Supply them with the --auth-username and --auth-password flags, or set the UDMG_CLI_AUTH_USERNAME and UDMG_CLI_AUTH_PASSWORD environment variables. For details and examples, see Authentication.
Subcommands
Use the following type subcommands with credentials create and credentials update to target a specific credential type.
| Subcommand | Credential Type |
|---|---|
ssh-private-key | Private Key |
ssh-public-key | Public Key |
pgp-private-key | PGP Private Key |
pgp-public-key | PGP Public Key |
auth-password | Standard Authentication |
auth-key | Username and Key |
auth-password-key | Username, Password, and Key |
x509-cert | X.509 Certificate |
x509-private-key | X.509 Private Key |
x509-cert-key | TLS Certificate Pair |
key-pair | Key Pair |
Commands Reference
list
Description
Returns all Credentials.
Required role
- Any
Command line syntax
udmg-client [global options] credentials list [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--enabled | Filter by enabled state. Accepted values: true, false. | No | (none) |
--type | Filter by credential type (e.g. ssh:private:key). | No | (none) |
--page | Page number. | No | (none) |
--page-size | Number of items per page. | No | (none) |
--order | Sort direction. Accepted values: asc, desc. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials list --enabled true --type ssh:private:key --page 1 --page-size 10 --order asc
get
Description
Retrieves the full definition of a Credential identified by name.
Required role
- Any
Command line syntax
udmg-client [global options] credentials get <name>
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials get sftp-key
delete
Description
Permanently deletes a Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials delete <name>
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials delete sftp-key
create
Description
Creates a Credential. A type subcommand must be specified to identify the kind of secret being stored.
create ssh-private-key
Description
Creates an ssh-private-key Credential storing an SSH private key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create ssh-private-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--key | PEM-encoded SSH private key. | Yes | N/A |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create ssh-private-key --name deploy-key --key "$(cat ~/.ssh/id_rsa)"
create ssh-public-key
Description
Creates an ssh-public-key Credential storing an SSH public key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create ssh-public-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--key | SSH public key (authorized_keys format). | Yes | N/A |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create ssh-public-key --name deploy-pub-key --key "$(cat ~/.ssh/id_rsa)"
create pgp-private-key
Description
Creates a pgp-private-key Credential storing a PGP private key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create pgp-private-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--key | PGP private key block (ASCII-armored). | Yes | N/A |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create pgp-private-key --name my-pgp-key --key "$(cat /path/to/pgp.key)"
create pgp-public-key
Description
Creates a pgp-public-key Credential storing a PGP public key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create pgp-public-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--key | PGP public key block (ASCII-armored). | Yes | N/A |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create pgp-public-key --name my-pgp-pub-key --key "$(cat /path/to/pgp.key)"
create auth-password
Description
Creates an auth-password Credential storing a username/password pair.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create auth-password [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--key | Key name (username or identifier). | Yes | N/A |
--value | Key value (password or secret). | No | (none) |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create auth-password --name alice-password --key alice --value Passw0rd!
create auth-key
Description
Creates an auth-key Credential storing a username with an SSH private key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create auth-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--username | Username. | Yes | N/A |
--private-key | PEM-encoded SSH private key. | Yes | N/A |
--passphrase | Passphrase for the private key. | No | (none) |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create auth-key --name alice-key --username alice --private-key "$(cat ~/.ssh/id_rsa)" --passphrase Passw0rd!
create auth-password-key
Description
Creates an auth-password-key Credential storing a username, password, and SSH private key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create auth-password-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--username | Username. | Yes | N/A |
--password | Password. | Yes | N/A |
--private-key | PEM-encoded SSH private key. | Yes | N/A |
--passphrase | Passphrase for the private key. | No | (none) |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create auth-password-key --name alice-combo --username alice --password Passw0rd! --private-key "$(cat ~/.ssh/id_rsa)" --passphrase Passw0rd!
create x509-cert
Description
Creates an x509-cert Credential storing an X.509 certificate.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create x509-cert [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--pem-data | PEM-encoded X.509 certificate. | Yes | N/A |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create x509-cert --name my-cert --pem-data "$(cat /path/to/cert.pem)"
create x509-private-key
Description
Creates an x509-private-key Credential storing an X.509 private key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create x509-private-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--pem-data | PEM-encoded X.509 private key. | Yes | N/A |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create x509-private-key --name my-private-key --pem-data "$(cat /path/to/cert.pem)"
create x509-cert-key
Description
Creates an x509-cert-key Credential storing an X.509 certificate with its matching private key.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create x509-cert-key [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--certificate | PEM-encoded X.509 certificate. | Yes | N/A |
--private-key | PEM-encoded private key. | Yes | N/A |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create x509-cert-key --name my-cert-key --certificate "$(cat /path/to/cert.pem)" --private-key "$(cat /path/to/cert.key)"
create key-pair
Description
Creates a key-pair Credential storing a symmetric key/value pair.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials create key-pair [command-specific options]
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--name | Credential name. | Yes | N/A |
--secret-key | Key name. | Yes | N/A |
--secret-value | Key value. | Yes | N/A |
--description | The description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339, e.g. 2026-01-01T00:00:00Z). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials create key-pair --name aws-keys --secret-key AKIAIOSFODNN7EXAMPLE --secret-value wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
update
Description
Updates a Credential. A type subcommand must be specified, followed by the name of the Credential to update.
update ssh-private-key
Description
Updates an ssh-private-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update ssh-private-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--key | PEM-encoded SSH private key. | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update ssh-private-key deploy-key --key "$(cat ~/.ssh/id_rsa)"
update ssh-public-key
Description
Updates an ssh-public-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update ssh-public-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--key | SSH public key (authorized_keys format). | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update ssh-public-key deploy-pub-key --key "$(cat ~/.ssh/id_rsa)"
update pgp-private-key
Description
Updates a pgp-private-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update pgp-private-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--key | PGP private key block (ASCII-armored). | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update pgp-private-key my-pgp-key --key "$(cat /path/to/pgp.key)"
update pgp-public-key
Description
Updates a pgp-public-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update pgp-public-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--key | PGP public key block (ASCII-armored). | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update pgp-public-key my-pgp-pub-key --key "$(cat /path/to/pgp.key)"
update auth-password
Description
Updates an auth-password Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update auth-password <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--key | Key name (username or identifier). | No | (none) |
--value | Key value (password or secret). | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update auth-password alice-password --key alice --value Passw0rd!
update auth-key
Description
Updates an auth-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update auth-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--username | Username. | No | (none) |
--private-key | PEM-encoded SSH private key. | No | (none) |
--passphrase | Passphrase for the private key. | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update auth-key alice-key --username alice --private-key "$(cat ~/.ssh/id_rsa)" --passphrase Passw0rd!
update auth-password-key
Description
Updates an auth-password-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update auth-password-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--username | Username. | No | (none) |
--password | Password. | No | (none) |
--private-key | PEM-encoded SSH private key. | No | (none) |
--passphrase | Passphrase for the private key. | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update auth-password-key alice-combo --username alice --password NewPassw0rd! --private-key "$(cat ~/.ssh/id_rsa)" --passphrase Passw0rd!
update x509-cert
Description
Updates an x509-cert Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update x509-cert <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--pem-data | PEM-encoded X.509 certificate. | No | (none) |
--name | New name for the Credential. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update x509-cert my-cert --pem-data "$(cat /path/to/cert.pem)"
update x509-private-key
Description
Updates an x509-private-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update x509-private-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--pem-data | PEM-encoded X.509 private key. | No | (none) |
--name | New name for the Credential. | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update x509-private-key my-private-key --pem-data "$(cat /path/to/cert.pem)"
update x509-cert-key
Description
Updates an x509-cert-key Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update x509-cert-key <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--certificate | PEM-encoded X.509 certificate. | No | (none) |
--private-key | PEM-encoded private key. | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update x509-cert-key my-cert-key --certificate "$(cat /path/to/cert.pem)" --private-key "$(cat /path/to/cert.key)"
update key-pair
Description
Updates a key-pair Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials update key-pair <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--secret-key | Key name. | No | (none) |
--secret-value | Key value. | No | (none) |
--name | New name for the Credential. | No | (none) |
--description | The new description of the Credential. | No | (none) |
--business-service | Business Service name to assign this Credential to. | No | (none) |
--valid-from | Validity start date (RFC3339). | No | (none) |
--valid-to | Validity end date (RFC3339). | No | (none) |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials update key-pair aws-keys --secret-key AKIAIOSFODNN7EXAMPLE --secret-value wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
enable
Description
Enables a Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
- Operator
Command line syntax
udmg-client [global options] credentials enable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials enable sftp-key
disable
Description
Disables a Credential.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
- Operator
Command line syntax
udmg-client [global options] credentials disable <name>
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials disable sftp-key
details
Description
Returns parsed details of the specified Credential, such as key fingerprints, certificate subject and expiry, and algorithm information, without returning the raw secret value.
Required role
- Any
Command line syntax
udmg-client [global options] credentials details <name>
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials details tls-cert
reveal
Description
Returns the decrypted secret value of the specified Credential. The response contains the plaintext secret.
Required role
- System Administrator
- Domain Administrator
- Pipeline Management
Command line syntax
udmg-client [global options] credentials reveal <name>
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials reveal sftp-key
assignments
Description
Returns all resources (Accounts, Endpoints, Pipelines, Tasks, and Domains) that currently reference the specified Credential.
Required role
- Any
Command line syntax
udmg-client [global options] credentials assignments <name> [command-specific options]
Arguments
| Argument | Description |
|---|---|
<name> | Credential name. |
Command-specific options
| Option | Description | Required | Default |
|---|---|---|---|
--extended | Include extended assignment details. | No | false |
Global options
See Global Options for connection, authentication, and output options. These can appear anywhere in the command line. Connection and authentication options can be supplied as environment variables.
Example
udmg-client credentials assignments my-credential --extended false