Overview
1Password is a password management and secrets storage platform used by individuals, teams, and enterprises to securely store credentials, sensitive documents, API keys, and other confidential information. The 1Password integration within the Wrk platform allows you to automate credential management workflows by interacting with the 1Password API through prebuilt Wrk Actions.
This document provides an overview of how 1Password integrates into Wrk, how authentication works, general API behaviour, and a list of available Wrk Actions.
Authentication
The 1Password integration uses 1Password Connect Server authentication to access the 1Password REST API. Wrk uses these credentials to authenticate all subsequent API requests.
How to Obtain Connect Server Credentials
To use the integration, you must deploy a 1Password Connect Server in your environment and generate a Connect API token.
The Connected Account requires:
Input | Description |
Connect Server URL | The base URL of your deployed 1Password Connect Server. |
Connect Token | The API token used to authenticate requests to the Connect Server. |
Important Notes
The Connect Server must be configured with access to the vaults required by your workflows.
All API requests are authorized using the Connect token and are limited to the permissions granted to the Connect Server.
If the Connect token is rotated or the Connect Server configuration changes, the Connected Account in Wrk must be updated accordingly.
General API Behaviour
Vault-Based Organization
Most resources in 1Password are organized within vaults. Items such as logins, secure notes, API credentials, and documents belong to a specific vault and are referenced using unique identifiers.
Many API operations require both the vault identifier and the item identifier to retrieve or modify data.
Resource Identifiers
Vaults, items, and other resources are represented by unique IDs. These IDs should be preserved exactly as returned by the API and supplied to subsequent update or retrieval operations.
Pagination
Collection endpoints may return paginated results when large numbers of objects exist. Applications should iterate through all available pages when retrieving complete datasets rather than assuming a single response contains every record.
Available Wrk Actions
Create a vault item in 1Password
Delete vault item in 1Password
Retrieve a vault from 1Password
Retrieve vault item file details from 1Password
Retrieve vault item files from 1Password
Retrieve vault item details from 1Password
Retrieve vault items from 1Password
Retrieve vaults from 1Password
Update vault item in 1Password
Additional Resources
1Password Developer Documentation: https://developer.1password.com/docs/
1Password Service Accounts Documentation: https://developer.1password.com/docs/service-accounts/
1Password SDKs and API Reference: https://developer.1password.com/docs/sdks/
1Password CLI Documentation: https://developer.1password.com/docs/cli/
1Password Developer Guides: https://developer.1password.com/docs/guides/