> For the complete documentation index, see [llms.txt](https://docs.isabl.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.isabl.io/project-privacy.md).

# Project Privacy

🔒 Configure metadata access and privacy by Project

{% hint style="success" %}
Since [`isabl_web@0.3.23`](https://www.npmjs.com/package/@papaemmelab/isabl-web/v/0.3.23) and [`isabl_api@1.1.0`](https://github.com/papaemmelab/isabl_api/releases/tag/v1.1.0) isabl supports project privacy.&#x20;
{% endhint %}

Projects now have an icon :lock: or `:share:` next to their title, that will show if a project is `private 🔒` or `public` , respectively.

<figure><img src="https://627844163-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgZ3I0-6juLK-X9gb1Z%2Fuploads%2FsOBzrcwupsKhWxL5IZls%2F252367736-651b4f1a-2ae4-43a8-a80b-4da327885238.png?alt=media&amp;token=316974e6-7fc2-4380-b24c-900e4aba3223" alt="" width="389"><figcaption><p> Icon <span data-gb-custom-inline data-tag="emoji" data-code="1f512">🔒</span> showing the project is Private.</p></figcaption></figure>

And this will be *blue* and *active* if the current user can modify its sharing permissions. When clicking the icon a modal to modify sharing settings will open:

<figure><img src="https://627844163-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgZ3I0-6juLK-X9gb1Z%2Fuploads%2F5NpABaDmAqdqb14xhVF4%2F252368399-1ad6c170-f3e2-4ddf-b326-6c0a8e80da42.png?alt=media&amp;token=891f528f-9e87-472e-94ac-d13dc43fb681" alt="" width="500"><figcaption><p>Project Sharing Settings Modal, when clicking the <span data-gb-custom-inline data-tag="emoji" data-code="1f512">🔒</span>icon.</p></figcaption></figure>

This will allow to configure which users **can view** and who **can share** permissions:

* By default: every superuser and the project owner can always view and share. And change the project **visibility** (Public/Private).
* The ones that **can view** can see all project metadata, experiments, analyses, submissions, etc.
* The ones that **can share** can modify the project settings, by adding new users to view and/or share.

Similarly, a **Project's Sharing Settings** can be optionally defined when creating a new project. It will be `public` always by default (In the screenshot shows `private` to show the available options in the form when private is selected).

<figure><img src="https://627844163-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgZ3I0-6juLK-X9gb1Z%2Fuploads%2FKuZzcOkjfouKFMl6DBIo%2F260786349-75f147c5-5dd8-4152-9eb7-c940140eb383.png?alt=media&amp;token=9ee9ce5b-c8f7-420f-9b34-8f95506a83d0" alt="" width="375"><figcaption></figcaption></figure>

**What metadata can be private?**

{% hint style="success" %}
In practical terms, the metadata of any model (`Individual`, `Sample`, `Aliquot`, `Submission, Analysis)` linked to an `Experiment` that belongs exclusively to private `Projects`, it will look like if **it doesn't exist in the database** for a user that doesn't have access to any of those private projects.
{% endhint %}

**Example:**&#x20;

There are 5 samples, where some belong to `Project 1` (🔒Private) and `Project 2` (📖 Public)

<figure><img src="https://627844163-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgZ3I0-6juLK-X9gb1Z%2Fuploads%2Fh7QVXuPxf0BQ8GFadGbf%2F260158944-4f8d9873-9917-471c-813c-c94f71a7eb19.png?alt=media&amp;token=0c4f6baa-dec3-4e35-acbd-5797f5171e3f" alt="" width="563"><figcaption></figcaption></figure>

* An user **with access** to the private `Project 1` will see all the `Experiments` with the following **Individual Tree**:

<figure><img src="https://627844163-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgZ3I0-6juLK-X9gb1Z%2Fuploads%2F6uuqYB01ttc9113gY6z3%2F260162966-f068c641-61c4-4f1b-99c1-4af14eeb531a.png?alt=media&amp;token=acfed5c9-1249-422b-a48c-2e89e7c5d02a" alt="" width="563"><figcaption></figcaption></figure>

* An user **without access** to the private `Project 1` will see only see the `Experiments` that belong to the public `Project 2` , with the following **Individual Tree**:

<figure><img src="https://627844163-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LgZ3I0-6juLK-X9gb1Z%2Fuploads%2FAIfDPwvzwSpDJ3aNbQ8z%2F260162950-5332506d-ab1f-4456-a45c-74413d582294.png?alt=media&amp;token=3dcadea6-7ce8-4845-9924-59f463b036f5" alt="" width="563"><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.isabl.io/project-privacy.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
