Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.1password.dev/llms.txt

Use this file to discover all available pages before exploring further.

By the end of this guide, you’ll:
  • Set up the 1Password app and CLI for administrative workflows.
  • Connect your 1Password account to your SIEM or security tools.
  • Prepare your team to use 1Password in development workflows.
To use 1Password developer tools to manage your organization, you’ll need a 1Password Business, 1Password Enterprise, or 1Password Teams account, and an owner or administrator role.

​
Step 1: Install the 1Password app

Install 1Password for Mac, Windows, or Linux and sign in with your administrator account. After you install the app:
  1. Open the 1Password app and select your account or collection at the top of the sidebar.
  2. Navigate to Settings > Security.
  3. Turn on the setting to unlock the app using Touch ID, Windows Hello, or Linux system authentication. This allows you to authenticate most developer tools with your fingerprint.

​
Step 2: Turn on the 1Password Developer experience

To turn on the developer tools section of the app:
  1. Open the 1Password app and select your account or collection at the top of the sidebar.
  2. Navigate to Settings > Developer.
  3. Turn on Show 1Password Developer experience.
You’ll see a new Developer entry in the sidebar with access to your SSH keys, CLI activity, Environments, and Watchtower.

​
Step 3: Install 1Password CLI

1Password CLI (op) is the fastest way to get started programmatically managing your team. To install 1Password CLI, run the following command or download the latest release. 
brew install 1password-cli
See the full CLI installation guide for requirements and additional Windows, Linux, and manual installation options.
Then turn on the app integration to sign in with the accounts you’ve added to the app and authenticate requests using your fingerprint.
  1. Open the 1Password app and select your account or collection at the top of the sidebar.
  2. Navigate to Settings > Developer.
  3. Select Integrate with 1Password CLI.
Enter any command to sign in. For example, to list all the vaults you have access to: 
op vault list
You can also use 1Password SDKs to build integrations with Go, JavaScript, or Python.

​
Step 4: Choose your first workflow

Monitor 1Password account activity

Connect the 1Password Events API to your SIEM to get information about account activity.

Prepare your team for developer tools

Set up policies and shared resources so your engineering team is ready to start using 1Password.

​
Monitor 1Password account activity

You can use the 1Password Events API to stream activity from your 1Password account into your SIEM.
  1. On 1Password.com, go to Integrations > Events Reporting.
  2. Choose your SIEM from the list or select Other.
  3. Name the integration and issue a bearer token scoped to the event types you need. Make sure to save the token in 1Password.
  4. Configure your SIEM to pull events from the API.

Get started with the Events API

Step-by-step setup for creating an Events Reporting integration, testing requests with curl, and connecting your SIEM.

​
Prepare your team to use developer tools

Take these actions before you roll out developer tools to your team:

​
Next steps

Choose what you want to do next:

Manage your organization

Automate managing users, groups, vaults, and permissions with 1Password CLI or SDKs and our library of prewritten scripts and integrations.

Get data and analytics

Generate account activity reports, send event data to your security and analytics tools, and trigger account access remediation.

Secure your team's development workflows

Configure policies and shared resources, then onboard engineers to developer tools.

Example scripts

Try example scripts for automating administrative tasks.