Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.8 KB

kfutil_login.md

File metadata and controls

51 lines (38 loc) · 2.8 KB

kfutil login

User interactive login to Keyfactor. Stores the credentials in the config file '$HOME/.keyfactor/command_config.json'.

Synopsis

Will prompt the user for a kfcUsername and kfcPassword and then attempt to login to Keyfactor. You can provide the --config flag to specify a config file to use. If not provided, the default config file will be used. The default config file is located at $HOME/.keyfactor/command_config.json. To prevent the prompt for kfcUsername and kfcPassword, use the --no-prompt flag. If this flag is provided then the CLI will default to using the environment variables: KEYFACTOR_HOSTNAME, KEYFACTOR_USERNAME, KEYFACTOR_PASSWORD and KEYFACTOR_DOMAIN.

WARNING: The 'username'' and 'password' will be stored in the config file in plain text at: '$HOME/.keyfactor/command_config.json.'

kfutil login [flags]

Options

  -h, --help   help for login

Options inherited from parent commands

      --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)
      --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")
      --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.
      --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.
      --username string                Username to use for authenticating to Keyfactor Command.

SEE ALSO

  • kfutil - Keyfactor CLI utilities
Auto generated by spf13/cobra on 27-Feb-2024