Skip to content

(closes #256) clarify documentation for setting up admin benchling app #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndamania00 merged 2 commits into from
Nov 10, 2026
Merged

(closes #256) clarify documentation for setting up admin benchling app #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abb7fdf
clarify documentation for setting up admin benchling app
ndamania00 Nov 10, 2026
2d9d978
access
ndamania00 Nov 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. **Benchling Admin Account**: Liminal builds on top of Benchling's LIMS system. You will need access and credentials to an admin account for your Benchling tenant(s). Liminal needs admin priveleges in order to manipulate Benchling schemas through their API.
1. **Benchling App with Admin Privileges**: Liminal builds on top of Benchling's LIMS system. You will need to have a Benchling App with admin privileges to your Benchling tenant(s). Liminal needs admin privileges in order to manipulate Benchling schemas through the Benchling API and SDK. Ensure the app is configured as an admin on all your entity schemas and dropdowns. [Follow instructions here](https://docs.benchling.com/docs/getting-started-benchling-apps#installing-your-app) to install a Benchling App with admin privileges.

2. **Python**: Liminal supports Python versions 3.10 through 3.13 for package users.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
...
```

* **Required**: The `api_client_id` and `api_client_secret` are used to connect to Benchling's SDK. For more information, see the [Benchling API documentation](https://docs.benchling.com/docs/getting-started-benchling-apps#calling-the-api-as-an-app).
* **Required**: The `api_client_id` and `api_client_secret` are used to connect to Benchling's SDK. For information on how to access these credentials from your Benchling App with admin privileges, see the [Benchling API documentation](https://docs.benchling.com/docs/getting-started-benchling-apps#calling-the-api-as-an-app).
* Optional: The `warehouse_connection_string` is used to connect to Benchling's read-only warehouse. If you have warehouse access, set this as the connection string for the warehouse.
* Optional: The `config_flags` parameter is used to set tenant-specific configuration flags. For more information, see the [BenchlingConnection](../reference/benchling-connection.md) reference.
* Set `schemas_enable_change_warehouse_name` to `True` if you want to enable changing schema and field warehouse names.
Expand Down