pingcli
A CLI tool for managing the configuration of Ping Identity products.
Synopsis
A CLI tool for managing the configuration of Ping Identity products.
Configuration: Settings resolve in priority order: command-line flag, environment variable, configuration file, then built-in default.
Every configuration key is settable by environment variable. The variable name is the key in upper snake case, prefixed with PINGCLI_ and with each path segment separated by an underscore. For example, the key service.pingOne.authentication.clientCredentials.clientID maps to PINGCLI_SERVICE_PINGONE_AUTHENTICATION_CLIENTCREDENTIALS_CLIENTID. Short aliases such as PINGCLI_PINGONE_CLIENT_CREDENTIALS_CLIENT_ID and PINGCLI_PINGONE_ENVIRONMENT_ID are also honoured, as are their bare PINGONE_* equivalents. Invalid environment-variable values are rejected with an error, the same as invalid flag values.
Use --profile (-P) to select a configured profile for a single command without changing the active profile.
pingcli
Options
-C, --config string The relative or full path to a custom Ping CLI configuration file. (default $HOME/.pingcli/config.yaml)
-h, --help help for pingcli
-D, --detailed-exitcode Enable detailed exit code output. (default false) 0 - pingcli command succeeded with no errors or warnings. 1 - pingcli command failed with errors. 2 - pingcli command succeeded with warnings.
-O, --output-format string Specify the console output format. (default text) Options are: json, ndjson, ndjson-typed, ndjson-wrapped, text.
-P, --profile string The name of a configuration profile to use.
--debug Enable debug output for error messages, including stack traces and transaction IDs. (default false)
--log-file string Write logs to a file at the given path. File logging is disabled when not set.
--log-file-level string Set the file log level. Options are: DEBUG, INFO, WARN, ERROR. (default DEBUG)
--log-level string Set the console log level. Options are: DEBUG, INFO, WARN, ERROR. (default WARN)
--no-color Disable text output in color. (default false)
--query string JMESPath expression to filter JSON output. Requires -O json, ndjson, ndjson-typed, or ndjson-wrapped. Example: --query 'data[?enabled].name'
Subcommands
-
pingcli agent-skills - Find and install agent skills for Ping CLI.
-
pingcli auth - Authenticate (or refresh authentication) for multiple connected products and services at once.
-
pingcli authorize - Administration tools for the PingOne Authorize universal service.
-
pingcli completion - Prints shell completion scripts
-
pingcli config - Manage the CLI configuration.
-
pingcli credentials - Administration tools for the PingOne Credentials universal service.
-
pingcli davinci - Administration tools for the PingOne DaVinci universal service.
-
pingcli feedback - Help us improve the CLI. Report issues or send us feedback on using the CLI tool.
-
pingcli init - Initialize Ping CLI with a guided setup wizard.
-
pingcli mfa - Administration tools for the PingOne MFA universal service.
-
pingcli pingfederate - Administration tools for PingFederate deployed as software
-
pingcli pingone - Administration tools for the PingOne platform.
-
pingcli protect - Administration tools for the PingOne Protect universal service.
-
pingcli verify - Administration tools for the PingOne Verify universal service.