-
@@ -26,7 +26,55 @@ If you're running a Linux distribution that still uses `libssl` version 1.1.1, s ## 🚀 Get started -To use the 1Password Python SDK in your project: +You can choose between two [authentication methods](https://developer.1password.com/docs/sdks/concepts#authentication) for the 1Password Python SDK: local authorization prompts from the [1Password desktop app](#option-1-1password-desktop-app) or automated authentication with a [1Password Service Account](#option-2-1password-service-account). + +### Option 1: 1Password desktop app + +[1Password desktop app authentication](https://developer.1password.com/docs/sdks/concepts#1password-desktop-app) is best for local integrations that require minimal setup from end users and sensitive workflows that require human-in-the-loop approval. To set up the SDK to authenticate with the 1Password app: + +1. Install the [1Password desktop app](https://1password.com/downloads/) and sign in to your account in the app. +2. Select your account or collection at the top of the sidebar, then navigate to **Settings** > **Developer**. +3. Under Integrate with the 1Password SDKs, select **Integrate with other apps**. +4. If you want to authenticate with biometrics, navigate to **Settings** > **Security**, then turn on the option to unlock using [Touch ID](https://support.1password.com/touch-id-mac/), [Windows Hello](https://support.1password.com/windows-hello/), or [system authentication](https://support.1password.com/system-authentication-linux/). +5. Install the 1Password Python SDK in your project: + + ```bash + pip install onepassword-sdk + ``` + +6. To use the Python SDK in your project, replace `your-account-name` in the code below with the name of your 1Password account as it appears at the top left sidebar of the 1Password desktop app. + +```python +import asyncio +import os +from onepassword.client import Client, DesktopAuth + +async def main(): + # Connects to 1Password. Fill in your own integration name and version. + client = await Client.authenticate( + auth=DesktopAuth( + # TODO: Set to your 1Password account name. + account_name="your-account-name" + ), + # TODO: Set to your own integration name and version. + integration_name="My 1Password Integration", + integration_version="v1.0.0", +) + + # Retrieves a secret from 1Password. Takes a secret reference as input and returns the secret to which it points. + value = await client.secrets.resolve("op://vault/item/field") + # use value here + +if __name__ == '__main__': + asyncio.run(main()) + +``` + +Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secret-reference-syntax/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code. + +### Option 2: 1Password Service Account + +[Service account authentication](https://developer.1password.com/docs/sdks/concepts/#1password-service-account) is best for automated access and limiting your integration to least privilege access. To set up the SDK to authenticate with a service account token: 1. [Create a service account](https://my.1password.com/developer-tools/infrastructure-secrets/serviceaccount/?source=github-sdk) and give it the appropriate permissions in the vaults where the items you want to use with the SDK are saved. 2. Provision your service account token. We recommend provisioning your token from the environment. For example, to export your token to the `OP_SERVICE_ACCOUNT_TOKEN` environment variable: @@ -80,7 +128,7 @@ Make sure to use [secret reference URIs](https://developer.1password.com/docs/cl ### Item management -Operations: +**Operations:** - [x] [Retrieve secrets](https://developer.1password.com/docs/sdks/load-secrets) - [x] [Retrieve items](https://developer.1password.com/docs/sdks/manage-items#get-an-item) @@ -92,7 +140,8 @@ Operations: - [x] [Share items](https://developer.1password.com/docs/sdks/share-items) - [x] [Generate PIN, random and memorable passwords](https://developer.1password.com/docs/sdks/manage-items#generate-a-password) -Field types: +**Field types:** + - [x] API Keys - [x] Passwords - [x] Concealed fields @@ -115,35 +164,51 @@ Field types: - [ ] Passkeys ### Vault management -- [ ] Retrieve vaults -- [ ] Create vaults ([#36](https://github.com/1Password/onepassword-sdk-python/issues/36)) -- [ ] Update vaults -- [ ] Delete vaults -- [x] [List vaults](https://developer.1password.com/docs/sdks/list-vaults-items/) + +- [x] [Retrieve vaults](https://developer.1password.com/docs/sdks/vaults#get-a-vault-overview) +- [x] [Create vaults](https://developer.1password.com/docs/sdks/vaults#create-a-vault) +- [x] [Update vaults](https://developer.1password.com/docs/sdks/vaults#update-a-vault) +- [x] [Delete vaults](https://developer.1password.com/docs/sdks/vaults#delete-a-vault) +- [x] [List vaults](https://developer.1password.com/docs/sdks/list-vaults-items#list-vaults) +- [x] [Manage group vault permissions](https://developer.1password.com/docs/sdks/vault-permissions) +- [ ] Manage user vault permissions ### User & access management + - [ ] Provision users - [ ] Retrieve users - [ ] List users - [ ] Suspend users +- [x] [Retrieve groups](https://developer.1password.com/docs/sdks/groups/) +- [ ] List groups - [ ] Create groups - [ ] Update group membership -- [ ] Update vault access & permissions + +## Environments management + +- [x] [Read 1Password Environments](https://developer.1password.com/docs/sdks/environments) (beta) ### Compliance & reporting + - [ ] Watchtower insights - [ ] Travel mode - [ ] Events. For now, use [1Password Events Reporting API](https://developer.1password.com/docs/events-api/) directly. ### Authentication -- [x] [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/) -- [ ] User authentication +- [x] [1Password Service Accounts](https://developer.1password.com/docs/sdks/concepts#1password-service-account) +- [x] [User authentication](https://developer.1password.com/docs/sdks/concepts#1password-desktop-app) - [ ] 1Password Connect. For now, use [1Password/connect-sdk-python](https://github.com/1Password/connect-sdk-python). ## 📖 Learn more -- [Load secrets with 1Password SDKs](https://developer.1password.com/docs/sdks/load-secrets) -- [Manage items with 1Password SDKs](https://developer.1password.com/docs/sdks/manage-items) -- [List vaults and items with 1Password SDKs](https://developer.1password.com/docs/sdks/list-vaults-items) +- [Load secrets](https://developer.1password.com/docs/sdks/load-secrets) +- [Read 1Password Environments (beta)](https://developer.1password.com/docs/sdks/environments) +- [Manage items](https://developer.1password.com/docs/sdks/manage-items) +- [Manage files](https://developer.1password.com/docs/sdks/files) +- [Share items](https://developer.1password.com/docs/sdks/share-items) +- [List vaults and items](https://developer.1password.com/docs/sdks/list-vaults-items) +- [Manage vaults](https://developer.1password.com/docs/sdks/vaults) +- [Manage vault permissions](https://developer.1password.com/docs/sdks/vault-permissions) +- [Manage groups](https://developer.1password.com/docs/sdks/groups) - [1Password SDK concepts](https://developer.1password.com/docs/sdks/concepts)