Skip to content

1Password Integration Guide

Connect KeyRunner to 1Password to securely access your secrets, credentials, and API keys.


Choose Your Connection Method

Option 2: Service Account Token


Option 1: Desktop App Integration

Prerequisites

  1. Install 1Password CLI

    macOS:

    bash
    brew install --cask 1password-cli

    Windows: Download from https://1password.com/downloads/command-line/

    Linux: Download from https://1password.com/downloads/command-line/

  2. Enable CLI Integration in 1Password Desktop App

    • Open 1Password desktop app
    • Go to Settings → Developer
    • Enable "Integrate with 1Password CLI"
    • Keep the 1Password app running

Configuration

IN KeyRunner UI Fill in the vault configuration form:

FieldValue
Vault IdentifierChoose a unique name (e.g., local, dev-vault)
Service Account TokenLeave empty
Connect Server URL1password url
Vault Name (Optional)Leave empty to access all vaults, or specify: "Employee" or "Employee, Personal"

Example:

Vault Identifier: local
Service Account Token: (empty)
Connect Server URL: https://example.1password.com
Vault Name: (empty or specify vault names)

Click Connect.


Option 2: Service Account Token

Prerequisites

  1. Create Service Account Token

  2. Have 1Password Connect Server URL (if using Connect server)

    • Example: http://localhost:8080 or your server URL

Configuration

Fill in the Keyrunner UI vault configuration form:

FieldValue
Vault IdentifierChoose a unique name (e.g., prod, staging)
Service Account TokenPaste your token (starts with ops_)
Connect Server URLYour Connect server URL (or leave empty if using 1Password.com)
Vault Name (Optional)Leave empty to access all vaults, or specify: "Production" or "Prod, Staging"

Example:

Vault Identifier: prod
Service Account Token: ops_eyJzaWduSW5...
Connect Server URL: http://localhost:8080
Vault Name: (empty or specify vault names)

3. Connect and Use Secrets

  • Once the details are entered, click on Connect.

  • Upon successful connection, you can view the secrets and use them globally, just like environment variables.

  • When you start typing with { anywhere in the input field, secrets will show up with the following notation:

  • OV for HashiCorp Vault opv Secrets

  • R for random variables

  • E for environment variables

Note: All the secrets are session variables and are not stored anywhere.

Vault Secrets

4. Additional Information

5. Future Methods

  • If you want any other Auth methods, please let us know, and we will incorporate them in future releases.

6. Disconnect

  • If you wish to disconnect, click on Disconnect. This will clear the cached secrets and delete the vault configuration file from your machine.

Released under the MIT License.