> 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/users.md).

# Users

## Overview

In Brigge *Settings*, you can view and manage user accounts for your company profile (and any other company files you manage) from the [*Users* page](#user-content-fn-1)[^1]. Here, you can view current users, edit user account details. 

Available options depend on your own role, but with appropriate permissions you can update user details, change the account status, manage 'child' company access (if you handle multiple company profiles), and assign roles.

## Working with the user list

The user list is grouped by company. If you don't manage multiple company profiles, you'll see users within your own company; if you manage more than one company, each company is shown. Key features of the *Users* page are shown below:

<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%2F3105sZcJSbxIn0kXKNyg%2Fuser%20list.svg?alt=media&amp;token=aa991c67-789b-459c-a62f-031dd8455ded" alt=""><figcaption></figcaption></figure></div>

These options are summarised below.

{% stepper %}
{% step %}
**Users grouped by company**

Expand a company group to view and manage associated users.
{% endstep %}

{% step %}
**Search for users**

Enter a full or partial string to search for users and companies by name. The search is not case sensitive.&#x20;
{% endstep %}

{% step %}
**Browse users**

Browse the list of users with navigation options at the bottom of the page. Set the rows per page to increase/decrease the number of users per page, and step through pages using page numbers. &#x20;
{% endstep %}

{% step %}
**View & edit user details**

Click the arrow associated with a user entry to view and manage the user account. For more information, see [Managing users](#managing-users).
{% endstep %}

{% step %}
**Invite new users**

Click the invite user button to send a Brigge access invitation to a given email address. For more information, see [Inviting users for your organisation](#inviting-users-for-your-organisation).
{% endstep %}
{% endstepper %}

## Managing users

The sections below provide guidance for adding and managing users associated with your company profile (and any other company profiles that you manage).&#x20;

<details>

<summary>Inviting users for your organisation</summary>

To add a new user account to work with a company profile that you manage in Brigge, access the [*Users* page](#user-content-fn-1)[^1] and click the `invite users` button. An *Invite user* page is displayed:

<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%2FqkSeTF5gDa0EXY4v681N%2Finvite%20users%201.png?alt=media&amp;token=82c76775-c77b-4034-ae3f-c520bb3b336f" alt=""><figcaption></figcaption></figure></div>

Enter invitation details, then click `send invite`. Your invitation is sent to the given email address, including a link for the recipient to complete their registration by setting a password. Invitation details are  summarised below:

<table><thead><tr><th width="205.64453125">Field</th><th>Summary</th></tr></thead><tbody><tr><td>Email address</td><td>Enter the email address for the person you are inviting to use Brigge.</td></tr><tr><td>Full name</td><td>Enter the display name to be applied throughout Brigge when this user is logged in.</td></tr><tr><td>Role</td><td>Select a role to determine the level of access this account will have in Brigge. You can apply a role equal to or lighter than your own.</td></tr><tr><td>Company</td><td><p>Select (or confirm) the company profile that this account will  see by default. If you manage multiple company profiles in Brigge, you can select anyone as the default.</p><p></p><p>Note that you're setting the default company here. Once the user is added, you can edit their details and <a href="#granting-user-access-to-other-managed-companies">grant access to other managed profiles</a>, if applicable.</p></td></tr></tbody></table>

</details>

<details>

<summary>Viewing &#x26; updating user details</summary>

To view or update account details for a user, access the [*Users* page](#user-content-fn-1)[^1] , then [find the user](#working-with-the-user-list) and click anywhere on their list entry. 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%2FouExP2EXov0zoW0CC28s%2Fedit%20user%20a.png?alt=media&amp;token=1efd2ad3-c5ca-4579-b2d5-ec07d95851ec" alt=""><figcaption></figcaption></figure></div>

Account details are displayed in the following sections:

* [Identity information ](#changing-a-users-identity-information)
* [Account status](#changing-a-users-account-status)
* [Primary company](#changing-a-users-primary-company)
* [Companies](#granting-user-access-to-other-managed-companies)
* [Roles](#assigning-user-roles)

</details>

<details>

<summary>Changing a user's identity information</summary>

To change identity information for a user (profile photo, display name, or email address), [access the user account](#viewing-and-updating-user-details) and update identity details. For example:&#x20;

<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%2FOTXFPasqPmGGz2QjkFYq%2Fidentity%201.png?alt=media&amp;token=bb0963bd-daef-4961-ac13-d95b67762ad9" alt=""><figcaption></figcaption></figure></div>

Make required changes and save the profile.&#x20;

</details>

<details>

<summary>Changing a user's account status</summary>

A user's account status determines whether they can log in to Brigge. An account can be set to one of three statuses:&#x20;

<table><thead><tr><th width="210.65234375">Account status</th><th>Summary</th></tr></thead><tbody><tr><td>Active</td><td>The user can log into Brigge and perform tasks associated with their <a href="#assigning-user-roles">role</a>.</td></tr><tr><td>Pending</td><td>An account <a href="#inviting-users-for-your-organisation">invitation has been sent to the user</a> and has not yet been accepted.</td></tr><tr><td>Suspended</td><td>The user cannot log into Brigge.</td></tr></tbody></table>

To change the account status for a user, [access the user account](#viewing-and-updating-user-details), scroll to the *Account status* section, then set the required status. For example:&#x20;

<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%2FXvYWxXFcGCJ3QjLaK1H7%2Faccount%20status.png?alt=media&amp;token=f291df28-861a-4518-b3ab-9c62682c58bb" alt=""><figcaption></figcaption></figure></div>

Having changed the status, save the profile.&#x20;

</details>

<details>

<summary>Changing a user's primary company</summary>

When a user logs into Brigge, they access their `primary` (i.e. default) company profile.

Sometimes this will be the *only* company profile associated with the account. Other times, a user account might manage multiple company profiles - in which case, one is nominated as the `primary` company.

To change the assigned primary account for a user, [access the user account](#viewing-and-updating-user-details), scroll to the *Primary company* section, then click in the `company` field. 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%2FeX2XHLZ4fVqsoCdM2MWW%2Fset%20primary%20companya.png?alt=media&amp;token=4c99600f-d447-4e6c-9991-a7671f51a105" alt=""><figcaption></figcaption></figure></div>

If multiple companies are available, you can choose which to assign. If only one company exists, this must be used.&#x20;

If you change this setting, remember to save the profile.&#x20;

</details>

<details>

<summary>Granting user access to other managed companies</summary>

If you manage multiple company profiles in Brigge, you can grant or revoke access to these for a specific user, via their user profile. To do this, [access the user account](#viewing-and-updating-user-details) and scroll to the *Company access* section. 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%2FJU5BCGJWMWhqrL83RWS8%2Fcompany%20access%201.png?alt=media&amp;token=b24c0a06-0f3e-4ced-b9bb-97aa601ee106" alt=""><figcaption></figcaption></figure></div>

Here, toggle options `on` to grant access and `off` to revoke access for a given company.

{% hint style="warning" %}
When company access is granted, the user has read-only access until you define the level of access they have to key resources within that company profile (subject to permissions associated with their [role](#assigning-user-roles)). For more information, see [Customising user access to company resources](#customising-user-access-to-company-resources).
{% endhint %}

If you update these settings, remember to save changes.

</details>

<details>

<summary>Customising user access to company resources</summary>

If you have [granted permission for a user to access a company](#granting-user-access-to-other-managed-companies) (whether that's a [primary](#changing-a-users-primary-company) company or an [additional](#granting-user-access-to-other-managed-companies) company), you need to define the level of access they have to key resources within that company profile.

{% hint style="warning" %}
When [company access is granted](#granting-user-access-to-other-managed-companies), the user has read-only access until you define the level of access they have to key resources within that company profile (subject to permissions associated with their [role](#assigning-user-roles)).&#x20;
{% endhint %}

To do this, [access the user account](#viewing-and-updating-user-details), scroll to the *Company access* section, then click the `customise` button. 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%2FRtpb0Ek0HGSoR8dGsfCQ%2Fcustomise%20access%201.png?alt=media&amp;token=5fb05e8e-9b5d-4625-ac93-43bae9e66894" alt=""><figcaption></figcaption></figure></div>

From here, you can define `read`, `update`, `create`, and `delete` access for [systems](/documentation/brigge-for-engineers/systems.md)*,* [pipelines](/documentation/brigge-for-transformers/pipelines.md), and [logs](/documentation/brigge-for-operators/history-and-retries.md#check-the-logs-and-associated-assets-for-this-run). 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%2Fsg6InZUBTfj9WmdGJWMx%2Fcustomise%20access%202.png?alt=media&amp;token=00518707-eb64-4724-ad3e-2bc7c91b80fe" alt=""><figcaption></figcaption></figure></div>

</details>

<details>

<summary>Assigning user roles</summary>

Every user account is associated with at least one role - a set of permissions which permit *access* *to* and then *actions* *with* specific areas of the Brigge platform.&#x20;

In Brigge, the topmost role is `administrator` (full access, and the ability to create [custom roles](/documentation/roles-and-permissions.md)). If you registered for Brigge, you will have this role by default. As such, you can invite users with the same or any lesser role. For more information, see [Roles & permissions](/documentation/roles-and-permissions.md).

To update roles for a user, [access the user account](#viewing-and-updating-user-details), scroll to the *Roles* section, then click the `pick a role` option. 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%2FDTmO7uDnF1YetngT33mG%2Fuser%20role%20assign%202.png?alt=media&amp;token=e616d3d8-af26-4cd3-a42f-3e4ac0694dcb" alt=""><figcaption></figcaption></figure></div>

From here, you can choose [any existing role](/documentation/roles-and-permissions.md) to be applied next time the user logs in. To remove a role, simply click the associated cross.

</details>

[^1]: Select *Settings* from the main navigation menu ➥ then select *Users* from the *Settings* menu.