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

# Roles & permissions

## Overview

A *role* is associated with a set of *permissions* that determine what a [user](/documentation/users.md) can see and do in Brigge, after logging in.

When you first register to use Brigge, your user account is created with the topmost `admin` role, so you have full access to the platform (including the ability to [invite more users](/documentation/users.md#inviting-users-for-your-organisation)). When sending invites, you decide what role to assign; this can be equal to or lower than your own.

## What roles are available?

A number of roles are available 'out of the box'. These are ['main' roles](#standard-roles-summary) (`admin`, `manager`, `user` and `read-only`), but as an `admin` user, you can also [create custom roles](#adding-a-custom-role) to assign permissions at a more granular level.

## Standard roles summary

Access for Brigge's 'main' roles is summarised below.

<table><thead><tr><th>Capability</th><th>Admin<select><option value="7svT9pt2bbTF" label="yes" color="blue"></option><option value="WjVDuSpTp4Pm" label="No" color="blue"></option></select></th><th>Manager<select><option value="G4rDuolrkq2h" label="yes" color="blue"></option><option value="yusTqQmaVIjp" label="no" color="blue"></option></select></th><th>User<select><option value="e6S5J2MiZlfl" label="yes" color="blue"></option><option value="iEau4XPBb2WU" label="no" color="blue"></option></select></th></tr></thead><tbody><tr><td>Auth flows (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Billing &#x26; subscriptions (view &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Brigge AI assistant</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Company settings (view &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Custom fields (create &#x26; manage variables)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Custom scripts (create &#x26; execute)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Data warehouses (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Environments (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>File-upload definitions (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Marketplace entries (view &#x26; install)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Notification groups (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Notification templates (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Pipeline deployments (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Pipeline field mappings (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Pipeline groups (build &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Pipeline payloads (view)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Pipeline runs (view)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Pipeline versions (view)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Pipeline-run actions (trigger/retry/stop)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Pipelines (build &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Pipeline transactions (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Pipeline transactions (view)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Pipeline trigger schedules</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Pipeline trigger webhooks</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Roles &#x26; permissions (view)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Roles &#x26; permissions (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>Schemas (create)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr><tr><td>System credentials (create &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>Systems (build, test &#x26; manage)</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="G4rDuolrkq2h">yes</span></td><td><span data-option="e6S5J2MiZlfl">yes</span></td></tr><tr><td>User management</td><td><span data-option="7svT9pt2bbTF">yes</span></td><td><span data-option="yusTqQmaVIjp">no</span></td><td><span data-option="iEau4XPBb2WU">no</span></td></tr></tbody></table>

{% hint style="info" %}
The `read-only` role is not shown here as it simply applies read access for all permissions.
{% endhint %}

## Working with roles

{% hint style="info" %}
Working with roles and associated permissions is restricted by your own role - you will only see information and options that your user role permits.
{% endhint %}

<details>

<summary>Viewing existing roles &#x26; permissions</summary>

To view existing roles for your organisation, select *Settings* from the navigation menu, then select *Roles* from the *User management* section. All existing roles (that your own role has permission to view or modify) are shown. For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FqBR59CroSXFnFPBZ8Gmd%2FRoles%201.png?alt=media&amp;token=ee301eb6-3677-46cc-99ec-3f19a4ddc3c3" alt=""><figcaption></figcaption></figure></div>

From here, click any role to view and update permissions. For example:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F65D0mLDOIKwToXgGh3XK%2FRoles%202.png?alt=media&amp;token=1339d515-c22a-4390-979d-31851b6d8d6a" alt="" width="376"><figcaption></figcaption></figure></div>

Permissions are displayed by category and those that are currently active are filled with a solid colour. For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FPzyIWwaxAKhw9maZRWIv%2FRoles%203.png?alt=media&amp;token=f25a5589-b3b8-4974-8273-4733e8ff8206" alt=""><figcaption></figcaption></figure></div>

</details>

<details>

<summary>Viewing &#x26; updating permissions for a role</summary>

Having [selected a role from the *Roles*](#viewing-existing-roles-and-permissions) page, all permissions (that your own role allows you to manage) are displayed in a series of categories.

<figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FKFSHjLrbaWr4Qcf6R7A5%2Froles%20-%20set%20permissions.svg?alt=media&amp;token=8686441b-7b9a-46f0-9dc5-1521acf54d9e" alt=""><figcaption></figcaption></figure>

Options for updating permissions are summarised below:

{% stepper %}
{% step %}
**Permission categories**

Permissions are grouped into the following categories: *Users and companies*; *Pipelines*; *Systems*; *History*; *AI*; *Logs & reporting*.
{% endstep %}

{% step %}
**Quick selections**

Quick select options&#x20;

* `clear all`. Clear all existing selections, ready to start again.
* `read all`. Select only the `read` permission for all items (you can then select any other permissions that you want to include, individually).
* `full access`. Select all permissions for all items (you can then de-select any that you wish to exclude, individually).
  {% endstep %}

{% step %}
**Individual permissions**

The permissions you see will depend on your own role. Those shown can be selected (activated) and de-selected (de-activated) as needed. The most common permissions are:

<table><thead><tr><th width="202.34375">Permission</th><th>Allows users to...</th></tr></thead><tbody><tr><td><code>read</code></td><td>View what items are available, without showing the details of any individual item. For example, allow users to read the <a href="/documentation/brigge-for-transformers/pipelines/the-pipeline-list.md">pipelines list</a>, but not to show details for a specific pipeline. </td></tr><tr><td><code>show</code></td><td>View details for an item. For example, <a href="/documentation/brigge-for-transformers/pipelines/the-pipeline-list.md#opening-a-pipeline-in-the-editor">show the setup of a pipeline in the editor</a>.</td></tr><tr><td><code>create</code></td><td>Create new items. For example, <a href="/documentation/brigge-for-transformers/pipelines/the-pipeline-list.md#adding-a-pipeline">create a new pipeline</a>.</td></tr><tr><td><code>update</code></td><td>Make changes to an item. For example, <a href="/documentation/brigge-for-transformers/pipelines/pipeline-nodes.md">update pipeline nodes</a> and <a href="/documentation/brigge-for-transformers/pipelines/pipeline-settings.md">settings</a>.</td></tr><tr><td><code>delete</code></td><td>Delete an item. For example, <a href="/documentation/brigge-for-transformers/pipelines/the-pipeline-list.md#deleting-a-pipeline">delete a pipeline</a>.</td></tr></tbody></table>
{% endstep %}
{% endstepper %}

</details>

<details>

<summary>Adding a custom role </summary>

To add a custom role, click the `new role` button from the [*Roles* page](#viewing-existing-roles-and-permissions). For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FUiMikSzyg5Vl4242xC8B%2Fnew%20role%201a.png?alt=media&amp;token=e646075f-2eeb-4ca5-8f9e-564bbc8a0f7e" alt=""><figcaption></figcaption></figure></div>

Click in the `add a description` field to enter edit mode, then provide a name/description for this role:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F6jX93spCk1phqQqBZvg4%2Fnew%20role%202.png?alt=media&amp;token=8735eed0-ec36-4d2e-8af6-549d1cbe7fb2" alt="" width="543"><figcaption></figcaption></figure></div>

Then [apply the required permissions](#viewing-and-updating-permissions-for-a-role) and save the role.

</details>
