For the complete documentation index, see llms.txt. This page is also available as Markdown.

Plugin Examples

This section provides a library of ready-to-use JSON templates covering the most common plugin integration scenarios for Keeper Endpoint Privilege Manager. Each sub-page focuses on a single scenario, includes a complete, deployable JSON file, and explains what the example demonstrates and when to use it.

All examples are self-describing — each file's description field begins with SCENARIO: so you can identify the purpose of the template at a glance without reading the entire file. Replace placeholder paths, IDs, and topic names before deploying to your environment.

Plugin Examples

Plugin files are placed under Plugins/{id}.json on the agent. The examples below cover the most common plugin registration and communication patterns.

Example
What It Covers

The simplest valid managed plugin on Windows: autoStart, a primary MQTT Subscription, and KeeperLogger output. Use this as your starting template on Windows.

Minimal Plugin — macOS

The same minimal plugin pattern adapted for macOS, including the correct binary path and platform configuration.

Minimal Plugin — Linux

The same minimal plugin pattern adapted for Linux, including the correct binary path and platform configuration.

A plugin using a command/response topic pattern (Commands/+, Responses/+, Status). Use this when your plugin needs to receive instructions and reply over MQTT.

Plugin with Manual Start

A plugin registered with autoStart: false, meaning it is not launched automatically when the agent starts. Use this for on-demand or conditionally launched plugins.

Before You Begin

  • Refer to the Custom Plugin Integration Guide before deploying any example to ensure you understand the binary layout, signing requirements, and MQTT topic permission model.

  • For a richer Windows job sample with more fields filled in, see the secrets-scanner-sample-job.json reference in the parent integration bundle.

  • Use POST /api/Jobs/validate to validate your job JSON before deploying it to an endpoint.

Last updated