1Password Connect Ansible Collection

Access and manage your 1Password items in your Ansible Automation Platform through your self-hosted 1Password Connect server.

The 1Password Connect collection contains modules that interact with your 1Password Connect deployment. The modules communicate with the 1Password Connect API to support Vault Item create/read/update/delete operations.

This project is licensed under GPL-3.0. Use of the 1Password APIs and services accessed through these tools is governed by the 1Password API Terms of Service.

Requirements

• ansible (community package): >=9.x (includes ansible-core 2.16)
• ansible-core: >=2.16.0
• python: >=3.10
• 1Password Connect: >= 1.0.0

✨ Get started

🚀 Quickstart

1. You can install the Ansible collection from Ansible Galaxy:

ansible-galaxy collection install onepassword.connect

2. Example of getting information about an Item, including fields and metadata:

---
hosts: localhost
vars:
  connect_token: "valid.jwt.here"
environment:
  OP_CONNECT_HOST: http://localhost:8001
collections:
  - onepassword.connect
tasks:
  - name: Find the item with the label "Staging Database" in the vault "Staging Env"
    item_info:
      token: "{{ connect_token }}"
      item: Staging Database
      vault: Staging Env
    no_log: true
    register: op_item

📄 Usage

Refer to the Usage Guide for usage examples.

📝 Changelog

Release notes for each version are documented in the Changelog.

💙 Community & Support

• File an issue for bugs and feature requests.
• Join the Developer Slack workspace.
• Subscribe to the Developer Newsletter.
• Red Hat customers: Open a support case through the "Create issue" link on the collection's Automation Hub page.

🔐 Security

1Password requests you practice responsible disclosure if you discover a vulnerability.

Please file requests by sending an email to [email protected].

📜 License

This collection is licensed under GPL-3.0-or-later.