The CLI Application Password SDK enables you to access passwords through the Credential Provider from a command line interface.
For examples and syntax, see Examples and syntax - CLI.
For a full list of supported platforms for which the CLI Application Password SDK for the Credential Provider is released, see Application Password SDKs.
During Credential Provider installation, the CLI Application Password SDK is stored in the following folder and is ready for use immediately afterwards:
<CP installation path>\CyberArk\ApplicationPasswordSdk
For more information about setting up the environment before using the SDK, refer to Build the environment for the Credential Provider.
When using path and/or hash application authentications, the CLI Password SDK restricts the shells that are allowed to request a password in the TrustedCLIShells parameter in order to allow security workflows to be enforced. This feature is enabled by default, and restricts password requests to be run using the following shells:
To override this feature, add the TrustedCLIShells parameter to the main configuration file with a list of values of shells that are allowed to request passwords.
- From a command line, run the CLI utility with the relevant parameters.
After the function runs successfully, it will display the output fields as requested in the command. If it fails, it will display an error message.