Users, Teams and Projects
Reference for the Benchling warehouse tables covering users, teams, and projects, including the available tables, key fields, and the relationships between them.
This page is for Developer Documentation.
Table Overview
| Name | $raw Filters | Description |
|---|---|---|
user | None | Lists all users |
principal | None | Lists all users + Apps |
team | None | Lists all teams |
team_member | None | Lists all members of teams |
project | archived$ column is not True | Lists all projects |
folder | archived$ column is not True | Lists all folders |
user
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| handle | Unique username chosen by individual users | Text | ”ssiegfried” | Handle can be changed at any point to any other unique string of text/integers |
| name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
| Unique email associated with each user account | ”user@example.com” | |||
| is_suspended | Suspension status for each user | Boolean | TRUE, FALSE | TRUE = Suspended user |
| created_at | Created date for user | Timestamp without timezone | 2019-12-06 23:24:45 |
principal
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| handle | Unique username chosen by individual users | Text | ”ssiegfried” | Handle can be changed at any point to any other unique string of text/integers |
| name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
| Unique email associated with each user account | ”user@example.com” | |||
| is_suspended | Suspension status for each user | Boolean | TRUE | TRUE = Suspended user |
| created_at | Created date for user | Timestamp without timezone | 2019-12-06 23:24:45 |
team
| Table Row | Definition | Value Type | Example values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table. Referred to as team_id when used as a foreign key. |
| name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
| description | Description given to object | Text | ”Fermentation Workflow” |
team_member
| Table Row | Definition | Value Type | Example values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| team_id | Unique identifier for the assignee’s team | Foreign key for team.id | team_oh5xGqrm | |
| user_id | Unique identifier for user | Foreign key for user.id | ent_yXrL3BjX | See user table for more information |
| role | Team membership status for an individual user | ADMIN, MEMBER | ADMIN, MEMBER |
project
| Table Row | Definition | Value Type | Example values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | If an object isn’t in a project, the permissions will be derived from the Registry |
| archived$ | Archival state for object in Benchling | Boolean | TRUE, FALSE | TRUE = folder is archived |
| archive_purpose$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = folder is not archived |
| name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
| created_at | Created date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| url | URL for each object in Benchling | Browser URL | https://demo.benchling.com/#biotech-org/f/lib_J3tmt8BP-Entry%20Namet/etr_gRogHFOb-untitled/edit |
folder
| Table Row | Definition | Value Type | Example values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | If an object isn’t in a project, the permissions will be derived from the Registry |
| archived$ | Archival state for object in Benchling | Boolean | TRUE, FALSE | TRUE = folder is archived |
| archive_purpose$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = folder is not archived |
| created_at | Created date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| modified_at | Most recent modified date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
| parent_folder_id | Unique identifier for folder containing object | Foreign key for folder.id | lib_J3tmt8BP |