License model
Table of contents
Introduction
Licenses track regulatory and compliance authorizations used by your lab, such as animal research approvals, biosafety permissions, controlled substance licenses, and import/export permits.
Fields
| Field | Description |
|---|---|
Name | Name/title of the license (required; string; maximum length: 255 characters). Example: “PPL: Septo-hippocampal dynamics 2025-2028” |
License type | Type of authorization or license (required; string; maximum length: 64 characters). Selected from predefined license types. |
Status | Current lifecycle state of the license (required; string; maximum length: 16 characters; default: draft). Active requires both validity dates; Expired is only valid after the expiration date has passed. |
License number | Official identifier shown on the approval document (string; maximum length: 128 characters). |
License holders | Named users associated with the license. |
Description | Rich text description of the license scope and purpose. |
Country | Country where the license was issued. |
Regulatory authority | Regulatory authority that issued the license. Must reference an existing regulatory authority. |
Valid from | Date when the license becomes valid (format: YYYY-MM-DD). |
Valid until | Date when the license expires (format: YYYY-MM-DD). Must be on or after Valid from when both dates are provided. |
License document | Uploaded approval file (PDF recommended). |
Authenticated groups | Groups assigned to this license for collaboration and permissions (required during creation). |
Public access | Designates if the license information is publicly available (boolean; default: False). Only owners can modify this setting. |
Permissions
Licenses follow personal-attribute permission patterns with group-based access and ownership management.
Visit the permissions page to learn more.
API access
The API allows for programmable access to licenses, enabling you to read, create, edit, and delete licenses through the API. Learn more about the fields and data structure on the License API page.