Skip to content

Commit e23dfa8

Browse files
committed
Add supported functionality
1 parent bfb4627 commit e23dfa8

File tree

1 file changed

+56
-20
lines changed

1 file changed

+56
-20
lines changed

README.md

Lines changed: 56 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,62 @@
1414

1515
---
1616

17-
The 1Password Python SDK offers programmatic access to your secrets in 1Password with Python. During the beta, you can create, retrieve, update, and delete items and resolve secret references.
18-
19-
1Password SDKs support authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/).
20-
21-
## Requirements
22-
23-
The 1Password Python SDK requires:
24-
25-
- `libssl` 3
26-
- `glibc` 2.32 or later
27-
28-
If you're running a Linux distribution that still uses `libssl` version 1.1.1, such as Debian 11 or Ubuntu 20.04, you'll need to update to a later version of Linux or install the required dependencies.
29-
30-
## ❗ Limitations
31-
32-
1Password SDKs don't yet support using secret references with query parameters, so you can't retrieve file attachments or SSH keys, or get more information about field metadata.
33-
34-
1Password SDKs currently only support operations on text and concealed fields. As a result, you can't edit items that include information saved in other types of fields.
35-
36-
When managing items with 1Password SDKs, you must use [unique identifiers (IDs)](https://developer.1password.com/docs/sdks/concepts#unique-identifiers) in place of vault, item, and field names.
17+
## Supported functionality
18+
19+
1Password SDKs are in active development. We're keen to hear what you'd like to see next. Let us know by [upvoting](https://github.com/1Password/onepassword-sdk-python/issues) or [filing](https://github.com/1Password/onepassword-sdk-python/issues/new/choose) an issue.
20+
21+
### Item management
22+
23+
Operations:
24+
25+
- [x] [Retrieve secrets](https://developer.1password.com/docs/sdks/load-secrets)
26+
- [x] [Retrieve items](https://developer.1password.com/docs/sdks/manage-items#get-an-item)
27+
- [x] [Create items](https://developer.1password.com/docs/sdks/manage-items#create-an-item)
28+
- [x] [Update items](https://developer.1password.com/docs/sdks/manage-items#edit-an-item)
29+
- [x] [Delete items](https://developer.1password.com/docs/sdks/manage-items#delete-an-item)
30+
- [ ] List items
31+
- [ ] Add & update tags on items
32+
33+
Field types:
34+
- [x] API Keys
35+
- [x] Passwords
36+
- [x] Concealed fields
37+
- [x] Text fields
38+
- [x] Notes
39+
- [x] SSH private keys (partially supported: supported in resolving secret references, not yet supported in item create/get/update)
40+
- [ ] SSH public keys, fingerprint and key type
41+
- [ ] One-time passwords \
42+
- [ ] Files attachments and Document items
43+
- [x] URLs
44+
- [x] Credit card number & type
45+
- [x] Phone numbers
46+
47+
### Vault management
48+
- [ ] Retrieve vaults
49+
- [ ] Create vaults ([#36](https://github.com/1Password/onepassword-sdk-python/issues/36))
50+
- [ ] Update vaults
51+
- [ ] Delete vaults
52+
- [ ] List vaults
53+
54+
### User & access management
55+
- [ ] Provision users
56+
- [ ] Retrieve users
57+
- [ ] List users
58+
- [ ] Suspend users
59+
- [ ] Create groups
60+
- [ ] Update group membership
61+
- [ ] Update vault access & permissions
62+
63+
### Compliance & reporting
64+
- [ ] Watchtower insights
65+
- [ ] Travel mode
66+
- [ ] Events. For now, use [1Password Events Reporting API](https://developer.1password.com/docs/events-api/) directly.
67+
68+
### Authentication
69+
70+
- [x] [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/)
71+
- [ ] User authentication
72+
- [ ] 1Password Connect. For now, use [1Password/connect-sdk-go](https://github.com/1Password/connect-sdk-go).
3773

3874
## 🚀 Get started
3975

0 commit comments

Comments
 (0)