CLI Provisioning with Commander SDK
Keeper Commander is an open-source Python SDK which can perform many vault and administrative functions within the Keeper system.
Keeper supports API-based provisioning through the use of our Python-based Keeper Commander SDK. The Keeper Commander SDK is open source Python code that is available for download from Keeper's Github Repository. The Commander SDK can assist in the following use cases:
  • Command line access to your Keeper vault
  • Importing passwords, folders and shared folder
  • Provisioning users and teams
  • Pushing records to users and teams
  • Sharing records and folders with users and teams
  • Performing targeted password rotation
  • Connecting to servers via SSH and RDP
Since Keeper Commander is an open source SDK and written in Python, it can be customized to meet your needs and integrated into your back-end systems.
For more information about Keeper Commander, visit: https://docs.keeper.io/secrets-manager/commander-cli/overview

Command-line Usage

Commander's command-line interface and interactive shell is a powerful and convenient way to access and control your Keeper vault and perform many administrative operations. To see all available commands, just type:
1
$ keeper
2
3
usage: keeper [--server SERVER] [--user USER] [--password PASSWORD]
4
[--version] [--config CONFIG] [--debug]
5
[command] [options [options ...]]
6
7
positional arguments:
8
command Command
9
options Options
10
11
optional arguments:
12
--server SERVER, -ks SERVER
13
Keeper Host address.
14
--user USER, -ku USER
15
Email address for the account.
16
--password PASSWORD, -kp PASSWORD
17
Master password for the account.
18
--version Display version
19
--config CONFIG Config file to use
20
--debug Turn on debug mode
Copied!

Interactive Shell

To run a series of commands and stay logged in, you will enjoy using Commander's interactive shell.
1
$ keeper shell
2
3
_ __
4
| |/ /___ ___ _ __ ___ _ _
5
| ' </ -_) -_) '_ \/ -_) '_|
6
|_|\_\___\___| .__/\___|_|
7
|_|
8
9
password manager & digital vault
10
11
Logging in...
12
Syncing...
13
Decrypted [400] Records
14
15
My Vault>
Copied!
Type h to display all commands and help information.

Keeper Command Reference

Commander has hundreds of features. Specifically with regards to User and Team provisioning, the following commands are relevant:
  • create-user
  • enterprise-info
  • enterprise-node
  • enterprise-user
  • enterprise-role
  • enterprise-team
  • enterprise-push
  • team-approve
Example with create-user:
1
My Vault> create-user -h
2
usage: create-user [-h] [--name NAME] [--node NODE] email
3
4
Send an invitation to the user to join Keeper
5
6
positional arguments:
7
email email
8
9
optional arguments:
10
-h, --help show this help message and exit
11
--name NAME user name (enterprise only)
12
--node NODE node name or node ID (enterprise only)
13
14
15
My Vault> create-user --name "Mary Jane" [email protected]
16
User '[email protected]' create and added to the enterprise
17
Copied!
Each command supports additional parameters and options. To get help on a particular command, use the -hflag.
Note: Some commands accept record or shared folder UID parameter. UID values may start with dash character (-) that is interpreted by command parser as an option. To pass a parameter starting with dash separate this parameter with two dashes (--). rmdir -- -Gd9l4daPw-fMd
For more Commander documentation, see the link below: https://docs.keeper.io/secrets-manager/commander-cli/overview
Export as PDF
Copy link
Contents