Keeper Security

https://docs.keeper.io/
Admin
This project provides comprehensive documentation, including release notes and user guides, for...
Tokens:1,609,758
Snippets:20,483
Trust Score:9.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get SSO Cloud Setup Guide

Source: https://docs.keeper.io/keeperpam/commander-cli/command-reference/enterprise-management-commands.md

Displays an IdP-specific setup guide with pre-filled values. Use this to follow step-by-step instructions for configuring your Identity Provider.

```bash
My Vault> sso-cloud guide "Azure SSO"
```

--------------------------------

### Clone Example Repository

Source: https://docs.keeper.io/keeper-connection-manager/using-keeper-connection-manager/custom-branding.md

Clone the example repository to get started with custom branding.

```bash
git clone https://github.com/Keeper-Security/kcm-branding.git
cd kcm-branding
```

--------------------------------

### Slack App Setup with Custom Names and Timeout

Source: https://docs.keeper.io/keeperpam/secrets-manager/integrations/slack-app.md

Example of the slack-app-setup command with custom parameters for folder name and timeout duration. This allows for tailored integration setup.

```bash
slack-app-setup --folder-name "My Slack Integration" --timeout 7d
```

--------------------------------

### Example GET Request to Create Student License

Source: https://docs.keeper.io/enterprise-guide/personal-vaults-for-enterprise-and-business-users/provision-student-plans-via-api.md

This is a raw GET request example demonstrating how to provision a student plan. Ensure all parameters, including the generated hash and partner name, are correctly included.

```http
GET https://keepersecurity.com/bi_api/v1/services/partner/create-license?product_type=4&transaction_id=UNIV-2024-00123&first_name=Jane&last_name=Smith&email=student@students.university.edu&hash=b94f6f125c79e3a5ffaa826f584c10d52ada669e6762051b826b55776d05a8d4&partner_name=YOUR_PARTNER_NAME
```

--------------------------------

### Example: Start Workflow Session

Source: https://docs.keeper.io/keeperpam/commander-cli/command-reference/keeperpam-commands.md

Example of using the 'pam workflow start' command to initiate a workflow session for a specific record.

```bash
My Vault> pam workflow start "Linux Server Prod"
```

--------------------------------

### Run the KCM Installer

Source: https://docs.keeper.io/keeper-connection-manager/installation/auto-docker-install.md

Execute the kcm-setup.run script with root privileges to start the Keeper Connection Manager installation process.

```bash
sudo ./kcm-setup.run
```

--------------------------------

### New Machine Setup for KCM

Source: https://docs.keeper.io/keeper-connection-manager/pre-release-testing.md

Set the image pattern and run the KCM setup script for a new machine installation. You will be prompted for a license key.

```bash
export KCM_SETUP_IMAGE_PATTERN="keepersecurityinc/%s-dev"
sudo -E ./kcm-setup.run
```

--------------------------------

### Example Deployment Script

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/deployment/deploy-with-windows.md

A sample script to silently install the Keeper Privilege Manager agent and then register it using a provided deployment token. Includes a delay to ensure the service starts.

```powershell
# Install silently
Start-Process msiexec.exe -ArgumentList "/i KeeperPrivilegeManager.msi /quiet /norestart" -Wait

# Give the service time to start
Start-Sleep -Seconds 20

# Register the device
Start-Process "C:\Program Files\Keeper Security\Endpoint Privilege Management\Jobs\bin\KeeperRegistrationHelper\KeeperRegistrationHelper.exe" `
    -ArgumentList "--token YOUR_TOKEN_HERE" -Wait
```

--------------------------------

### Install Docker on Amazon Linux 2

Source: https://docs.keeper.io/sso-connect-cloud/device-approvals/automator/kubernetes-service.md

Installs Docker, enables it to start on boot, and starts the Docker service. This is a prerequisite for Kubernetes.

```sql
sudo yum update -y
sudo yum install -y docker
sudo systemctl enable docker
sudo systemctl start docker
```

--------------------------------

### Example Deployment Script for Scale

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/deployment/deploy-with-linux.md

A sample bash script demonstrating the installation and registration process, suitable for automation tools like Ansible.

```bash
#!/bin/bash
# Install package
dpkg -i keeper-privilege-manager*.deb

# Start service
systemctl start keeper-privilege-manager

# Wait for startup
sleep 20

# Register device
/opt/keeper/sbin/Jobs/bin/KeeperRegistrationHelper/KeeperRegistrationHelper --token="YOUR_TOKEN_HERE"
```

--------------------------------

### Query Documentation Example

Source: https://docs.keeper.io/keeper-connection-manager/installation/docker-compose-install/ssl-termination/keeper-guacamole-ssl-nginx.md

Demonstrates how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://docs.keeper.io/keeper-connection-manager/installation/docker-compose-install/ssl-termination/keeper-guacamole-ssl-nginx.md?ask=<question>
```

--------------------------------

### Teams App Setup with Custom Options

Source: https://docs.keeper.io/keeperpam/secrets-manager/integrations/teams-app.md

Example of running the `teams-app-setup` command with custom folder and timeout values. This allows for tailored configuration of the integration.

```bash
teams-app-setup --folder-name "My Teams Integration" --timeout 7d
```

--------------------------------

### Query Documentation API Example

Source: https://docs.keeper.io/enterprise-guide/webhooks/discord-webhooks.md

This example shows how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. Replace '<question>' with your specific query to retrieve answers and relevant documentation excerpts.

```bash
GET https://docs.keeper.io/enterprise-guide/webhooks/discord-webhooks.md?ask=<question>
```

--------------------------------

### Querying Documentation Example

Source: https://docs.keeper.io/keeperpam/privileged-access-manager/password-rotation/rotation-use-cases/local-network/database/ms-sql-server.md

To ask questions about the documentation, perform an HTTP GET request with the 'ask' query parameter.

```bash
GET https://docs.keeper.io/keeperpam/privileged-access-manager/password-rotation/rotation-use-cases/local-network/database/ms-sql-server.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.keeper.io/keeperpam/privileged-access-manager/password-rotation/post-rotation-scripts/accessing-parameters.md

This example shows how to query the documentation dynamically by performing an HTTP GET request to a documentation URL with an 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.keeper.io/keeperpam/privileged-access-manager/password-rotation/post-rotation-scripts/accessing-parameters.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/integrations/examples/plugin-manual-start.md

This example shows how to perform an HTTP GET request to query the documentation dynamically. Replace `<question>` with your specific query.

```http
GET https://docs.keeper.io/keeperpam/endpoint-privilege-manager/integrations/examples/plugin-manual-start.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/reference/jobs-run-guide-keeperadmincli.md

This example shows how to perform an HTTP GET request to query the documentation dynamically. Use this to ask specific questions about the content.

```http
GET https://docs.keeper.io/keeperpam/endpoint-privilege-manager/reference/jobs-run-guide-keeperadmincli.md?ask=<question>
```

--------------------------------

### Basic Environment Variable Setup Example

Source: https://docs.keeper.io/keeperpam/commander-cli/commander-installation-setup/configuration/configure-default-working-directory.md

Demonstrates setting `KEEPER_DATA_HOME` to a custom path and launching Commander. The configuration file will be stored in the specified directory with `.keeper` appended.

```bash
# Set custom data directory
export KEEPER_DATA_HOME="/opt/keeper"
keeper shell
# config.json stored in: /opt/keeper/.keeper/
```

--------------------------------

### Install and Configure SSH Server on Windows

Source: https://docs.keeper.io/keeperpam/privileged-access-manager/references/setting-up-ssh.md

Installs the OpenSSH server, starts the service, and configures the firewall to allow SSH connections on Windows. Ensures the service starts automatically on reboot.

```powershell
# Install OpenSSH
Add-WindowsCapability -Online -Name OpenSSH.Server

# Start service and make sure it automatically starts after reboot.
Start-Service sshd
Set-Service -Name sshd -StartupType 'Automatic'

# Make sure the the firewall will allow SSH connections
if (!(Get-NetFirewallRule -Name "OpenSSH-Server-In-TCP" -ErrorAction SilentlyContinue | Select-Object Name, Enabled)) {
    Write-Output "Firewall Rule 'OpenSSH-Server-In-TCP' does not exist, creating it..."
    New-NetFirewallRule -Name 'OpenSSH-Server-In-TCP' -DisplayName 'OpenSSH Server (sshd)' -Enabled True -Direction Inbound -Protocol TCP -Action Allow -LocalPort 22
} else {
    Write-Output "Firewall rule 'OpenSSH-Server-In-TCP' has been created and exists."
}
```

--------------------------------

### Docker Compose Up Command and Output

Source: https://docs.keeper.io/keeperpam/secrets-manager/integrations/docker-runtime.md

This example shows the command to run the docker-compose setup and the expected output, illustrating the KSM CLI splash screen and the successful retrieval of the secret value into the 'MY_LOGIN' environment variable.

```bash
$ example : docker-compose up
[+] Running 2/0
 ⠿ Container example-init-1  Created                                                                                                                      0.0s
 ⠿ Container example-main-1  Recreated                                                                                                                    0.1s
Attaching to example-init-1, example-main-1
example-init-1  | 
example-init-1  | ██╗  ██╗███████╗███╗   ███╗     ██████╗██╗     ██╗
example-init-1  | ██║ ██╔╝██╔════╝████╗ ████║    ██╔════╝██║     ██║
example-init-1  | █████╔╝ ███████╗██╔████╔██║    ██║     ██║     ██║
example-init-1  | ██╔═██╗ ╚════██║██║╚██╔╝██║    ██║     ██║     ██║
example-init-1  | ██║  ██╗███████║██║ ╚═╝ ██║    ╚██████╗███████╗██║
example-init-1  | ╚═╝  ╚═╝╚══════╝╚═╝     ╚═╝     ╚═════╝╚══════╝╚═╝
example-init-1  | 
example-init-1  | Current Version: 1.0.13
example-init-1  | 
example-init-1  | Running in shell mode. Type 'quit' to exit.
example-init-1  | 
example-init-1 exited with code 0
example-main-1  | john.smith@localhost
example-main-1 exited with code 0

```

--------------------------------

### GPO Startup Script - CMD Installation

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/deployment/deploy-with-windows.md

Installs the MSI package silently and then registers the device using the CMD helper. Ensure the token is replaced with your actual token.

```cmd
msiexec /i KeeperPrivilegeManager.msi /quiet /norestart

timeout /t 20

"C:\Program Files\Keeper Security\Endpoint Privilege Management\Jobs\bin\KeeperRegistrationHelper\KeeperRegistrationHelper.exe" --token "YOUR_TOKEN_HERE"
```

--------------------------------

### Start Docker Service

Source: https://docs.keeper.io/sso-connect-cloud/device-approvals/automator/docker-compose.md

Starts the Docker service if it is not running. Ensure Docker is installed before running this command.

```bash
sudo service docker start
```

--------------------------------

### Get Command JSON Response

Source: https://docs.keeper.io/keeperpam/commander-cli/service-mode-rest-api/api-usage.md

Example of a formatted JSON response for the `get` command, providing details about a folder or record.

```json
{ "command": "get", "data": { "attachments": "service_config.yaml 537b ID: XYZ", "last_modified": "2025-01-18 15:35:21", "share_admins": "<xyz@email.com>", "shared": "False", "shared_users": "<xyz@email.com> (Owner)", "title": "Commander Service Mode", "type": "", "uid": "folder_uid_string" }, "status": "success" }
```

--------------------------------

### Add Client to Application (Basic)

Source: https://docs.keeper.io/keeperpam/commander-cli/command-reference/secrets-manager-commands.md

Add a new client device to an application and generate a one-time access token for initializing the client. This is the basic method for device setup.

```bash
My Vault> sm client add --app Ansible --name "Test 1"

Successfully generated Client Device
====================================
One-Time Access Token: US:_wYNCeeLmBSdDgkcE77NyMcO-6DqLutNO1NylWVyco
Name: Test 1
IP Lock: Enabled
Token Expires On: 2021-09-30 22:52:46
App Access Expires on: Never

```

--------------------------------

### Install Keeper Secrets Manager using Chef

Source: https://docs.keeper.io/keeperpam/secrets-manager/integrations/chef.md

Installs the Keeper Secrets Manager using the `ksm_install` Chef resource. This example configures the installation to include the Python SDK but not the CLI tool.

```ruby
# Install Keeper Secrets Manager
ksm_install 'keeper_setup' do
  python_sdk true
  cli_tool false
  action :install
end
```

--------------------------------

### Basic JIT Launch

Source: https://docs.keeper.io/keeperpam/commander-cli/command-reference/keeperpam-commands/pam-launch-jit.md

Use this command to initiate a session with Just-In-Time provisioning enabled for the record. Ensure the record is configured with JIT settings.

```bash
My Vault> pam launch -r <record-uid> -j
```

--------------------------------

### Install Docker on Linux

Source: https://docs.keeper.io/sso-connect-cloud/device-approvals/automator/docker-on-linux.md

Installs Docker using the yum package manager. Ensure Docker service is started and enabled for automatic startup.

```bash
sudo yum install docker
```

```bash
sudo service docker start
```

```bash
sudo systemctl enable docker.service
```

--------------------------------

### Query Documentation Example

Source: https://docs.keeper.io/keeperpam/privileged-access-manager/password-rotation/rotation-use-cases/azure/managed-database/azure-mysql-single-or-flexible-database.md

Demonstrates how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information or clarification not explicitly present on the page.

```bash
GET https://docs.keeper.io/keeperpam/privileged-access-manager/password-rotation/rotation-use-cases/azure/managed-database/azure-mysql-single-or-flexible-database.md?ask=<question>
```

--------------------------------

### Create Login Record Example

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/golang-sdk.md

This example demonstrates creating a 'login' type record, including generating a secure password and filling in login credentials. Ensure the provided folder UID is accessible by your Secrets Manager application.

```go
// create a new login record
newLoginRecord := ksm.NewRecordCreate("login", "Sample KSM Record: Go SDK")

// generate password
password, err := ksm.GeneratePassword(32, "", "", "", "", "")
if err != nil {
  fmt.Printf("Error generating password: %v\n", err)
  return
}

// fill in login and password fields
newLoginRecord.Fields = append(newLoginRecord.Fields,
  ksm.NewLogin("username@email.com"),
  ksm.NewPassword(password))

// fill in notes
newLoginRecord.Notes = "This is a Go record creation example"

// create the new record
recordUid, err := sm.CreateSecretWithRecordData("", "[FOLDER UID]", newLoginRecord)
if err != nil {
  fmt.Printf("Error creating record: %v\n", err)
  return
}

fmt.Printf("Record created with UID: %s\n", recordUid)
```

--------------------------------

### Install Podman and Helpers (Ubuntu/Debian)

Source: https://docs.keeper.io/keeper-connection-manager/installation/podman-install.md

Installs Podman, Podman Compose, firewalld, and haveged on Debian-based systems. Enables and starts the haveged service for enhanced entropy.

```bash
sudo apt update && sudo apt install -y podman podman-compose firewalld haveged
sudo systemctl enable --now haveged
```

--------------------------------

### Install Podman and Helpers (RHEL/Fedora)

Source: https://docs.keeper.io/keeper-connection-manager/installation/podman-install.md

Installs Podman, Podman Compose, firewalld, and haveged on RHEL-based systems. Enables and starts the haveged service for enhanced entropy.

```bash
sudo dnf install -y podman podman-compose firewalld haveged
sudo systemctl enable --now haveged   # adds extra entropy for SSL
```

--------------------------------

### Sample Sync Results Output

Source: https://docs.keeper.io/keeperpam/privileged-access-manager/universal-secrets-sync/discovery-using-commander.md

Example output displaying configuration details and the sync status for each folder. 'Success' indicates proper synchronization, while 'Failed' requires checking Gateway logs and permissions.

```text
UID              qZkz5qoShpQL2J_TKurbRw
Name             AWS USS Configuration
Config Type      pamAwsConfiguration
Enabled          Yes
Dry Run          Yes
Vault Name       N/A
Sync Identity    N/A

Folders (3)

Cloud Secrets AWS
  Last Synced    2026-06-08 14:24:56
  Status         Success

Cloud Secrets AWS #2
  Last Synced    2026-06-08 14:24:56
  Status         Success

Cloud Secrets AWS #3
  Last Synced    2026-06-08 14:24:56
  Status         Success
```

--------------------------------

### Get All Secrets by Title Example

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/rust-sdk.md

Example demonstrating how to initialize the Secrets Manager and retrieve all secrets matching the title 'My Credentials'. Requires the `keeper_secrets_manager_core` crate.

```rust
use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // setup secrets manager
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // get all secrets matching the record title
    let matching_secrets = secrets_manager.get_secrets_by_title("My Credentials")?;
    println!("Found {} matching secrets", matching_secrets.len());

    Ok(())
}
```

--------------------------------

### Query Documentation Example

Source: https://docs.keeper.io/keeperpam/commander-sdk/keeper-commander-sdks/sdk-command-reference/reporting-commands/user-report-command.md

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.keeper.io/keeperpam/commander-sdk/keeper-commander-sdks/sdk-command-reference/reporting-commands/user-report-command.md?ask=<question>
```

--------------------------------

### Install Go SDK

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/golang-sdk.md

Install the Go SDK from GitHub using the go get command. This command fetches the core package of the secrets manager Go SDK.

```bash
$ go get github.com/keeper-security/secrets-manager-go/core
```

--------------------------------

### Example of Reading Folders

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/golang-sdk.md

Demonstrates initializing the Secrets Manager and retrieving all folders. It prints the total number of folders retrieved.

```go
package main

import (
  "fmt"
  ksm "github.com/keeper-security/secrets-manager-go/core"
)

func main() {
  options := &ksm.ClientOptions{Config: ksm.NewFileKeyValueStorage("ksm-config.json")}
  sm := ksm.NewSecretsManager(options)

  folders, err := sm.GetFolders()
  if err != nil {
    fmt.Printf("Error: %v\n", err)
    return
  }

  fmt.Printf("Retrieved %d folder(s)\n", len(folders))
}
```

--------------------------------

### Example: Uploading a File with Java SDK

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/java-sdk.md

Demonstrates a complete example of uploading a file. Ensure the security provider is loaded and pre-initialized storage is available. Reads file bytes and creates a KeeperFileUpload object before calling uploadFile.

```java
import com.keepersecurity.secretsManager.core.*;

import java.io.File;
import java.io.FileInputStream;
import java.util.Arrays;

public class KSMSample {
    public static void main(String[] args){
    
        // Ensure security provider is loaded
        Security.addProvider(new BouncyCastleFipsProvider());

        // get pre-initialized storage
        KeyValueStorage storage = new LocalConfigStorage("ksm-config.json");
        try {
            SecretsManagerOptions options = new SecretsManagerOptions(storage);

            // create a filter with the UID of the record we want
            List<String> uidFilter = List.of("XXX");

            // fetch secrets with the filter
            KeeperSecrets secrets = SecretsManager.getSecrets(options, uidFilter);

            // get the desired secret to upload a file to
            KeeperRecord ownerRecord = secrets.getRecords().get(0);
        
            // get bytes from file to upload
            File file = new File("./myFile.json");
            FileInputStream fl = new FileInputStream(file);
            byte[] fileBytes = new byte[(int)file.length()];
            fl.read(fileBytes);
            fl.close();
            
            // create a Keeper File to upload
            KeeperFileUpload myFile = new KeeperFileUpload(
                "myFile.json",
                "My File", 
                "application/json", 
                fileBytes
            )

            // upload the file to the selected record
            SecretsManager.uploadFile(options, ownerRecord, myFile);
            
        } catch (Exception e) {
            System.out.println("KSM ran into an problem: " + e.getMessage());
        }
    }
}
```

--------------------------------

### Example Usage: Get TOTP Code

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/java-sdk.md

This example shows how to retrieve secrets, obtain the TOTP URL from a record using Keeper Notation, and then convert that URL into a TotpCode object.

```java
import static com.keepersecurity.secretsManager.core.Notation.*
import static com.keepersecurity.secretsManager.core.TotpCode.*
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

... 

// get secrets
KeeperSecrets secrets = getSecrets(options);

// get TOTP url from record
String url= getValue(secrets, "BediNKCMG21ztm5xGYgNww/field/oneTimeCode");

// get TOTP code
TotpCode totp = uriToTotpCode(url);
```

--------------------------------

### Streamlined Service Creation (HTTP, Foreground)

Source: https://docs.keeper.io/keeperpam/commander-cli/service-mode-rest-api.md

Quickly configures the service with a specified port, command list, and JSON configuration format. Defaults to HTTP and foreground mode.

```bash
service-create -p 9090 -c 'record-add,whoami' -f json
```

--------------------------------

### Login Record Example

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/rust-sdk.md

Example demonstrating how to set up the Secrets Manager client and create a login record with a password and custom fields.

```rust
use keeper_secrets_manager_core::
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError,
    dto::{dtos::RecordCreate, field_structs::RecordField},
    utils
;
use serde_json::{self, json, Number, Value};

fn main()-> Result<(), KSMRError>{
    // setup secrets manager
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // This is how we create a Record
    let mut created_record =  RecordCreate::new("login".to_string(), "Login Record RUST_LOG_TEST".to_string(), Some("Dummy Notes".to_string()));
    
    // This is how we create a single field 
    let password_field = RecordField::new_record_field_with_options("password", Value::String(utils::generate_password()?), Some("Random password label".to_string()), false, true);

    //This is one way to create all fields directly in a vector
    let fields = vec![
        RecordField::new_record_field("login", Value::String("login@email.com".to_string()), Some("My Custom Login lbl".to_string())),

        password_field,
     ];

    created_record.fields = Some(fields);
  
    // Make the API call
    let _ = secrets_manager.create_secret("Shared_folder_uid".to_string(), created_record)?;
    Ok(())
}
```

--------------------------------

### Kubernetes Init Container Example

Source: https://docs.keeper.io/keeperpam/secrets-manager/integrations/docker-writer-image.md

Example of using the Docker Writer Image within a Kubernetes Init Container to fetch secrets and files before the main application container starts.

```yaml
 initContainers:
    - name: my_app
      image: keeper/keeper-secrets-manager-writer:latest
      env:
        - name: SECRETS
          value: |
            qCAw9dMQgr3Hs7EdfFpfkA/field/password > my_password
            qCAw9dMQgr3Hs7EdfFpfkA/file/exmaple.crt > file:/etc/keys/example.crt
            qCAw9dMQgr3Hs7EdfFpfkA/file/exmaple.key > file:/etc/keys/example.key
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.keeper.io/user-guides/import-records-1/import-from-1password.md

To get answers to specific questions not explicitly covered on the page, make an HTTP GET request to the page URL with the 'ask' query parameter.

```http
GET https://docs.keeper.io/user-guides/import-records-1/import-from-1password.md?ask=<question>
```

--------------------------------

### Display Help Information

Source: https://docs.keeper.io/sso-connect-on-prem/installation-and-setup/installation-linux/linux-command-line-config.md

Use this command to display all available command-line options and their descriptions for SSO Connect.

```bash
java -jar SSOConnect.jar -h
```

--------------------------------

### Example GET Request with ASK Parameter

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/integrations/custom-job-guide.md

Perform an HTTP GET request to query the documentation dynamically. The 'ask' parameter should contain a specific, self-contained question in natural language.

```http
GET https://docs.keeper.io/keeperpam/endpoint-privilege-manager/integrations/custom-job-guide.md?ask=<question>
```

--------------------------------

### Install Skills to Multiple Agents

Source: https://docs.keeper.io/keeperpam/secrets-manager/integrations/ai-agents/manual-install.md

Installs skills to multiple agent directories (Claude Code, Cursor, Codex) in a single operation. This simplifies setup when using several agents.

```bash
# Claude Code + Cursor + Codex
for dir in ~/.claude/skills ~/.cursor/skills ~/.codex/skills; do
  mkdir -p "$dir"
  cp -r plugins/*/skills/* "$dir/"
done
```

--------------------------------

### Initial SFTP Sync Setup

Source: https://docs.keeper.io/keeperpam/commander-cli/command-reference/connection-commands/sftp-sync.md

Use this command the first time you set up an SFTP sync. It requires specifying the plugin type, remote path, and the Keeper record containing SFTP credentials.

```bash
rsync "path/to/files_location/" --plugin sftp --remote-path "/path/to/files" --record "credentials/SFTP creds"
```

--------------------------------

### Install and Enable haveged on RHEL

Source: https://docs.keeper.io/keeper-connection-manager/installation/preparing-for-installation.md

Install the `haveged` service from the EPEL repository on RHEL systems to increase entropy generation speed. Ensure the service is started and enabled to run on boot.

```bash
sudo yum install haveged
sudo systemctl start haveged
sudo systemctl enable haveged
```

--------------------------------

### Get First Secret by Title Example

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/rust-sdk.md

Example showing how to initialize the Secrets Manager and retrieve the first secret matching the title 'My Credentials'. It handles cases where no secret is found.

```rust
use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // setup secrets manager
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;

    // get first secret matching the record title
    if let Some(secret) = secrets_manager.get_secret_by_title("My Credentials")? {
        println!("Found secret: {}", secret.uid);
    } else {
        println!("No secret found with that title");
    }

    Ok(())
}
```

--------------------------------

### Query Documentation API Example

Source: https://docs.keeper.io/keeperpam/commander-sdk/keeper-commander-sdks/sdk-command-reference/reporting-commands.md

To get additional information not explicitly present on a page, perform an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.keeper.io/keeperpam/commander-sdk/keeper-commander-sdks/sdk-command-reference/reporting-commands.md?ask=<question>
```

--------------------------------

### Example Interactive Service Creation with TLS

Source: https://docs.keeper.io/keeperpam/commander-cli/service-mode-rest-api.md

An example of an interactive service creation process, including enabling TLS, specifying certificate paths, enabling request queue, and setting run mode and commands.

```bash
My Vault> service-create
Enter Port No:9090
Enable Ngrok Tunneling? (y/n):n
Enable TLS Certificate (y/n):y
Enter Certificate Path:/Users/cert/cert.pem
Enter Certificate Password:/Users/cert/key.pem
Enable Request Queue? (y/n):y
Enable Advanced Security? (y/n):n
Select Run Mode (foreground/background):foreground
List of supported commands, Enter comma separated:whoami,record-add,tree,ls
Select configuration format (json/yaml):yaml
Generated API key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Uploading service_config.yaml ...
Commander Service starting on https://localhost:9090/api/v2/
Commander Service started with PID: 35215
```

--------------------------------

### Basic InstallLauncher Usage

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/integrations/examples/plugin-install-launcher.md

Invoke InstallLauncher to install an MSI package. This is the most straightforward way to use the tool for basic installations.

```bash
InstallLauncher C:\path\to\package.msi
```

--------------------------------

### Create Gateway for Docker Install via CLI

Source: https://docs.keeper.io/keeperpam/privileged-access-manager/getting-started/gateways/one-time-access-token.md

Initialize a Gateway for Docker installation. This command generates a base64 encoded configuration, which should be provided as the GATEWAY_CONFIG environment variable during Docker setup.

```bash
pam gateway new -n "My Demo Gateway" -a "My Infrastructure" -c b64
```

--------------------------------

### Start Commander Shell

Source: https://docs.keeper.io/keeperpam/commander-cli/commander-installation-setup/configuration/using-commander-with-aws-lambda.md

Initiates the Commander shell session on your local machine for device setup.

```shell
$ keeper shell
```

--------------------------------

### GPO Startup Script - PowerShell Installation

Source: https://docs.keeper.io/keeperpam/endpoint-privilege-manager/deployment/deploy-with-windows.md

Installs the MSI package silently and then registers the device using the PowerShell helper. Ensure the token is replaced with your actual token.

```powershell
msiexec /i KeeperPrivilegeManager.msi /quiet /norestart

Start-Sleep -Seconds 20

"C:\Program Files\Keeper Security\Endpoint Privilege Management\Jobs\bin\KeeperRegistrationHelper\KeeperRegistrationHelper.exe" --token "YOUR_TOKEN_HERE"
```

--------------------------------

### Multiple Container Setup Commands

Source: https://docs.keeper.io/sso-connect-cloud/device-approvals/automator/aws-elastic-container-service.md

When running multiple containers, execute the setup, init, and enable commands for each container to ensure proper configuration.

```bash
automator setup "My Automator"
automator setup "My Automator"
automator setup "My Automator"

automator init "My Automator"
automator init "My Automator"
automator init "My Automator"

automator enable "My Automator"
automator enable "My Automator"
automator enable "My Automator"
```

--------------------------------

### Install Docker on Amazon Linux 2

Source: https://docs.keeper.io/keeperpam/privileged-access-manager/references/installing-docker-on-linux.md

Installs Docker Engine and the Compose v2 plugin using amazon-linux-extras. Enables and starts the Docker service, and adds the current user to the docker group.

```bash
# Engine from amazon-linux-extras
sudo yum update -y
sudo amazon-linux-extras install -y docker
sudo systemctl enable --now docker
sudo usermod -aG docker $USER
newgrp docker

# Install Compose v2 plugin so `docker compose` works
sudo mkdir -p /usr/local/lib/docker/cli-plugins
sudo curl -SL "https://github.com/docker/compose/releases/download/v2.27.0/docker-compose-linux-x86_64" \
  -o /usr/local/lib/docker/cli-plugins/docker-compose
sudo chmod +x /usr/local/lib/docker/cli-plugins/docker-compose

# Verify
docker --version
docker compose version

# Start the service and set to run on reboot
sudo service docker start
sudo chkconfig docker on
```

--------------------------------

### Install and Enable haveged on CentOS/Rocky Linux

Source: https://docs.keeper.io/keeper-connection-manager/installation/preparing-for-installation.md

Install the `haveged` service from the EPEL repository on CentOS or Rocky Linux systems. Start and enable the service to ensure it runs automatically on system startup.

```bash
sudo yum install epel-release
sudo yum install haveged
sudo systemctl start haveged
sudo systemctl enable haveged
```

--------------------------------

### Login Record Example

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/.net-sdk.md

Example demonstrating the creation of a 'login' type record with a username and a generated password. Replace '[FOLDER UID]' with the actual shared folder UID.

```csharp
var newRecord = new KeeperRecordData{type = "login", title = "Sample KSM Record: C#"};

newRecord.fields = new[]
{
    new KeeperRecordField { type = "login", value = new[] { "My Username" } },
    new KeeperRecordField { type = "password", value = new[] { CryptoUtils.GeneratePassword() } },
};
newRecord.notes = "This is a C# record creation example";

var recordUid = await SecretsManagerClient.CreateSecret(options, folderUid, newRecord);
```

--------------------------------

### Get Secrets Basic

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/rust-sdk.md

A basic example of how to retrieve secrets. An empty filter fetches all accessible secrets.

```rust
let records_filter = Vec::new(); // add record filters of needed based on UID
let secrets = secrets_manager.get_secrets(records_filter)?;
```

--------------------------------

### Example of Reading Folders

Source: https://docs.keeper.io/keeperpam/secrets-manager/developer-sdk-library/rust-sdk.md

Demonstrates setting up the Secrets Manager with an in-memory configuration and then retrieving all folders. Replace 'your_base64_goes_here' with your actual configuration string.

```rust
use keeper_secrets_manager_core::{
    core::{ClientOptions, SecretsManager},
    storage::InMemoryKeyValueStorage,
    custom_error::KSMRError
};
fn main()-> Result<(), KSMRError>{
    // setup secrets manager
    let config_string = "your_base64_goes_here".to_string();
    let config = InMemoryKeyValueStorage::new_config_storage(Some(config_string))?;
    let client_options = ClientOptions::new_client_options(config);
    let mut secrets_manager = SecretsManager::new(client_options)?;
    
    // get all folder
    let folders = secrets_manager.get_folders()?;
    Ok(())
}
```
Tokens:
Raw