|
| 1 | +--- |
| 2 | +title: 1Password |
| 3 | +description: Manage secrets and items in 1Password vaults |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="onepassword" |
| 10 | + color="#E0E0E0" |
| 11 | +/> |
| 12 | + |
| 13 | +{/* MANUAL-CONTENT-START:intro */} |
| 14 | +[1Password](https://1password.com) is a widely trusted password manager and secrets vault solution, allowing individuals and teams to securely store, access, and share passwords, API credentials, and sensitive information. With robust encryption, granular access controls, and seamless syncing across devices, 1Password supports teams and organizations in managing secrets efficiently and securely. |
| 15 | + |
| 16 | +The [1Password Connect API](https://developer.1password.com/docs/connect/) allows programmatic access to vaults and items within an organization's 1Password account. This integration in Sim lets you automate secret retrieval, onboarding workflows, secret rotation, vault audits, and more, all in a secure and auditable manner. |
| 17 | + |
| 18 | +With 1Password in your Sim workflow, you can: |
| 19 | + |
| 20 | +- **List, search, and retrieve vaults**: Access metadata or browse available vaults for organizing secrets by project or purpose |
| 21 | +- **Fetch items and secrets**: Get credentials, API keys, or custom secrets in real time to power your workflows securely |
| 22 | +- **Create, update, or delete secrets**: Automate secret management, provisioning, and rotation for enhanced security practices |
| 23 | +- **Integrate with CI/CD and automation**: Fetch credentials or tokens only when needed, reducing manual work and reducing risk |
| 24 | +- **Ensure access controls**: Leverage role-based access and fine-grained permissions to control which agents or users can access specific secrets |
| 25 | + |
| 26 | +By connecting Sim with 1Password, you empower your agents to securely manage secrets, reduce manual overhead, and maintain best practices for security automation, incident response, and DevOps workflows—all while ensuring secrets never leave a controlled environment. |
| 27 | +{/* MANUAL-CONTENT-END */} |
| 28 | + |
| 29 | + |
| 30 | +## Usage Instructions |
| 31 | + |
| 32 | +Access and manage secrets stored in 1Password vaults using the Connect API or Service Account SDK. List vaults, retrieve items with their fields and secrets, create new items, update existing ones, delete items, and resolve secret references. |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +## Tools |
| 37 | + |
| 38 | +### `onepassword_list_vaults` |
| 39 | + |
| 40 | +List all vaults accessible by the Connect token or Service Account |
| 41 | + |
| 42 | +#### Input |
| 43 | + |
| 44 | +| Parameter | Type | Required | Description | |
| 45 | +| --------- | ---- | -------- | ----------- | |
| 46 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 47 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 48 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 49 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 50 | +| `filter` | string | No | SCIM filter expression \(e.g., name eq "My Vault"\) | |
| 51 | + |
| 52 | +#### Output |
| 53 | + |
| 54 | +| Parameter | Type | Description | |
| 55 | +| --------- | ---- | ----------- | |
| 56 | +| `vaults` | array | List of accessible vaults | |
| 57 | +| ↳ `id` | string | Vault ID | |
| 58 | +| ↳ `name` | string | Vault name | |
| 59 | +| ↳ `description` | string | Vault description | |
| 60 | +| ↳ `attributeVersion` | number | Vault attribute version | |
| 61 | +| ↳ `contentVersion` | number | Vault content version | |
| 62 | +| ↳ `type` | string | Vault type \(USER_CREATED, PERSONAL, EVERYONE, TRANSFER\) | |
| 63 | +| ↳ `createdAt` | string | Creation timestamp | |
| 64 | +| ↳ `updatedAt` | string | Last update timestamp | |
| 65 | + |
| 66 | +### `onepassword_get_vault` |
| 67 | + |
| 68 | +Get details of a specific vault by ID |
| 69 | + |
| 70 | +#### Input |
| 71 | + |
| 72 | +| Parameter | Type | Required | Description | |
| 73 | +| --------- | ---- | -------- | ----------- | |
| 74 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 75 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 76 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 77 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 78 | +| `vaultId` | string | Yes | The vault UUID | |
| 79 | + |
| 80 | +#### Output |
| 81 | + |
| 82 | +| Parameter | Type | Description | |
| 83 | +| --------- | ---- | ----------- | |
| 84 | +| `id` | string | Vault ID | |
| 85 | +| `name` | string | Vault name | |
| 86 | +| `description` | string | Vault description | |
| 87 | +| `attributeVersion` | number | Vault attribute version | |
| 88 | +| `contentVersion` | number | Vault content version | |
| 89 | +| `items` | number | Number of items in the vault | |
| 90 | +| `type` | string | Vault type \(USER_CREATED, PERSONAL, EVERYONE, TRANSFER\) | |
| 91 | +| `createdAt` | string | Creation timestamp | |
| 92 | +| `updatedAt` | string | Last update timestamp | |
| 93 | + |
| 94 | +### `onepassword_list_items` |
| 95 | + |
| 96 | +List items in a vault. Returns summaries without field values. |
| 97 | + |
| 98 | +#### Input |
| 99 | + |
| 100 | +| Parameter | Type | Required | Description | |
| 101 | +| --------- | ---- | -------- | ----------- | |
| 102 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 103 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 104 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 105 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 106 | +| `vaultId` | string | Yes | The vault UUID to list items from | |
| 107 | +| `filter` | string | No | SCIM filter expression \(e.g., title eq "API Key" or tag eq "production"\) | |
| 108 | + |
| 109 | +#### Output |
| 110 | + |
| 111 | +| Parameter | Type | Description | |
| 112 | +| --------- | ---- | ----------- | |
| 113 | +| `items` | array | List of items in the vault \(summaries without field values\) | |
| 114 | +| ↳ `id` | string | Item ID | |
| 115 | +| ↳ `title` | string | Item title | |
| 116 | +| ↳ `vault` | object | Vault reference | |
| 117 | +| ↳ `id` | string | Vault ID | |
| 118 | +| ↳ `category` | string | Item category \(e.g., LOGIN, API_CREDENTIAL\) | |
| 119 | +| ↳ `urls` | array | URLs associated with the item | |
| 120 | +| ↳ `href` | string | URL | |
| 121 | +| ↳ `label` | string | URL label | |
| 122 | +| ↳ `primary` | boolean | Whether this is the primary URL | |
| 123 | +| ↳ `favorite` | boolean | Whether the item is favorited | |
| 124 | +| ↳ `tags` | array | Item tags | |
| 125 | +| ↳ `version` | number | Item version number | |
| 126 | +| ↳ `state` | string | Item state \(ARCHIVED or DELETED\) | |
| 127 | +| ↳ `createdAt` | string | Creation timestamp | |
| 128 | +| ↳ `updatedAt` | string | Last update timestamp | |
| 129 | +| ↳ `lastEditedBy` | string | ID of the last editor | |
| 130 | + |
| 131 | +### `onepassword_get_item` |
| 132 | + |
| 133 | +Get full details of an item including all fields and secrets |
| 134 | + |
| 135 | +#### Input |
| 136 | + |
| 137 | +| Parameter | Type | Required | Description | |
| 138 | +| --------- | ---- | -------- | ----------- | |
| 139 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 140 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 141 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 142 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 143 | +| `vaultId` | string | Yes | The vault UUID | |
| 144 | +| `itemId` | string | Yes | The item UUID to retrieve | |
| 145 | + |
| 146 | +#### Output |
| 147 | + |
| 148 | +| Parameter | Type | Description | |
| 149 | +| --------- | ---- | ----------- | |
| 150 | +| `response` | json | Operation response data | |
| 151 | + |
| 152 | +### `onepassword_create_item` |
| 153 | + |
| 154 | +Create a new item in a vault |
| 155 | + |
| 156 | +#### Input |
| 157 | + |
| 158 | +| Parameter | Type | Required | Description | |
| 159 | +| --------- | ---- | -------- | ----------- | |
| 160 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 161 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 162 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 163 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 164 | +| `vaultId` | string | Yes | The vault UUID to create the item in | |
| 165 | +| `category` | string | Yes | Item category \(e.g., LOGIN, PASSWORD, API_CREDENTIAL, SECURE_NOTE, SERVER, DATABASE\) | |
| 166 | +| `title` | string | No | Item title | |
| 167 | +| `tags` | string | No | Comma-separated list of tags | |
| 168 | +| `fields` | string | No | JSON array of field objects \(e.g., \[\{"label":"username","value":"admin","type":"STRING","purpose":"USERNAME"\}\]\) | |
| 169 | + |
| 170 | +#### Output |
| 171 | + |
| 172 | +| Parameter | Type | Description | |
| 173 | +| --------- | ---- | ----------- | |
| 174 | +| `response` | json | Operation response data | |
| 175 | + |
| 176 | +### `onepassword_replace_item` |
| 177 | + |
| 178 | +Replace an entire item with new data (full update) |
| 179 | + |
| 180 | +#### Input |
| 181 | + |
| 182 | +| Parameter | Type | Required | Description | |
| 183 | +| --------- | ---- | -------- | ----------- | |
| 184 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 185 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 186 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 187 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 188 | +| `vaultId` | string | Yes | The vault UUID | |
| 189 | +| `itemId` | string | Yes | The item UUID to replace | |
| 190 | +| `item` | string | Yes | JSON object representing the full item \(e.g., \{"vault":\{"id":"..."\},"category":"LOGIN","title":"My Item","fields":\[...\]\}\) | |
| 191 | + |
| 192 | +#### Output |
| 193 | + |
| 194 | +| Parameter | Type | Description | |
| 195 | +| --------- | ---- | ----------- | |
| 196 | +| `response` | json | Operation response data | |
| 197 | + |
| 198 | +### `onepassword_update_item` |
| 199 | + |
| 200 | +Update an existing item using JSON Patch operations (RFC6902) |
| 201 | + |
| 202 | +#### Input |
| 203 | + |
| 204 | +| Parameter | Type | Required | Description | |
| 205 | +| --------- | ---- | -------- | ----------- | |
| 206 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 207 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 208 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 209 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 210 | +| `vaultId` | string | Yes | The vault UUID | |
| 211 | +| `itemId` | string | Yes | The item UUID to update | |
| 212 | +| `operations` | string | Yes | JSON array of RFC6902 patch operations \(e.g., \[\{"op":"replace","path":"/title","value":"New Title"\}\]\) | |
| 213 | + |
| 214 | +#### Output |
| 215 | + |
| 216 | +| Parameter | Type | Description | |
| 217 | +| --------- | ---- | ----------- | |
| 218 | +| `response` | json | Operation response data | |
| 219 | + |
| 220 | +### `onepassword_delete_item` |
| 221 | + |
| 222 | +Delete an item from a vault |
| 223 | + |
| 224 | +#### Input |
| 225 | + |
| 226 | +| Parameter | Type | Required | Description | |
| 227 | +| --------- | ---- | -------- | ----------- | |
| 228 | +| `connectionMode` | string | No | Connection mode: "service_account" or "connect" | |
| 229 | +| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) | |
| 230 | +| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) | |
| 231 | +| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) | |
| 232 | +| `vaultId` | string | Yes | The vault UUID | |
| 233 | +| `itemId` | string | Yes | The item UUID to delete | |
| 234 | + |
| 235 | +#### Output |
| 236 | + |
| 237 | +| Parameter | Type | Description | |
| 238 | +| --------- | ---- | ----------- | |
| 239 | +| `success` | boolean | Whether the item was successfully deleted | |
| 240 | + |
| 241 | +### `onepassword_resolve_secret` |
| 242 | + |
| 243 | +Resolve a secret reference (op://vault/item/field) to its value. Service Account mode only. |
| 244 | + |
| 245 | +#### Input |
| 246 | + |
| 247 | +| Parameter | Type | Required | Description | |
| 248 | +| --------- | ---- | -------- | ----------- | |
| 249 | +| `connectionMode` | string | No | Connection mode: must be "service_account" for this operation | |
| 250 | +| `serviceAccountToken` | string | Yes | 1Password Service Account token | |
| 251 | +| `secretReference` | string | Yes | Secret reference URI \(e.g., op://vault-name/item-name/field-name or op://vault-name/item-name/section-name/field-name\) | |
| 252 | + |
| 253 | +#### Output |
| 254 | + |
| 255 | +| Parameter | Type | Description | |
| 256 | +| --------- | ---- | ----------- | |
| 257 | +| `value` | string | The resolved secret value | |
| 258 | +| `reference` | string | The original secret reference URI | |
| 259 | + |
| 260 | + |
0 commit comments