Skip to content

Latest commit

 

History

History
49 lines (41 loc) · 3.59 KB

kfutil.md

File metadata and controls

49 lines (41 loc) · 3.59 KB
Raw

kfutil

Keyfactor CLI utilities

Synopsis

A CLI wrapper around the Keyfactor Platform API.

Options

      --api-path string                API Path to use for authenticating to Keyfactor Command. (default is KeyfactorAPI) (default "KeyfactorAPI")
      --auth-provider-profile string   The profile to use defined in the securely stored config. If not specified the config named 'default' will be used if it exists. (default "default")
      --auth-provider-type string      Provider type choices: (azid)
      --client-id string               OAuth2 client-id to use for authenticating to Keyfactor Command.
      --client-secret string           OAuth2 client-secret to use for authenticating to Keyfactor Command.
      --config string                  Full path to config file in JSON format. (default is $HOME/.keyfactor/command_config.json)
      --debug                          Enable debugFlag logging.
      --domain string                  Domain to use for authenticating to Keyfactor Command.
      --exp                            Enable expEnabled features. (USE AT YOUR OWN RISK, these features are not supported and may change or be removed at any time.)
      --format text                    How to format the CLI output. Currently only text is supported. (default "text")
  -h, --help                           help for kfutil
      --hostname string                Hostname to use for authenticating to Keyfactor Command.
      --log-insecure                   Log insecure API requests. (USE AT YOUR OWN RISK, this WILL log sensitive information to the console.)
      --no-prompt                      Do not prompt for any user input and assume defaults or environmental variables are set.
      --offline                        Will not attempt to connect to GitHub for latest release information and resources.
      --password string                Password to use for authenticating to Keyfactor Command. WARNING: Remember to delete your console history if providing kfcPassword here in plain text.
      --profile string                 Use a specific profile from your config file. If not specified the config named 'default' will be used if it exists.
      --token-url string               OAuth2 token endpoint full URL to use for authenticating to Keyfactor Command.
      --username string                Username to use for authenticating to Keyfactor Command.

SEE ALSO

  • kfutil completion - Generate the autocompletion script for the specified shell
  • kfutil containers - Keyfactor certificate store container API and utilities.
  • kfutil export - Keyfactor instance export utilities.
  • kfutil helm - Helm utilities for configuring Keyfactor Helm charts
  • kfutil import - Keyfactor instance import utilities.
  • kfutil login - User interactive login to Keyfactor. Stores the credentials in the config file '$HOME/.keyfactor/command_config.json'.
  • kfutil logout - Removes the credentials file '$HOME/.keyfactor/command_config.json'.
  • kfutil orchs - Keyfactor agents/orchestrators APIs and utilities.
  • kfutil pam - Keyfactor PAM Provider APIs.
  • kfutil status - List the status of Keyfactor services.
  • kfutil store-types - Keyfactor certificate store types APIs and utilities.
  • kfutil stores - Keyfactor certificate stores APIs and utilities.
  • kfutil version - Shows version of kfutil
Auto generated by spf13/cobra on 6-Nov-2024