> For the complete documentation index, see [llms.txt](https://docs.cloudscaff.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloudscaff.com/settings/user-management/add-or-update-permissions.md).

# Add or Update Permissions

Permissions define what each user can see, create, edit, approve, or delete across the Cloudscaff system.

Permissions control access to modules, data, and specific functions, ensuring that every team member only interacts with information relevant to their role.

***

## Purpose

In Cloudscaff, permissions are used to:

* **Protect company data** — limit sensitive or financial data to specific roles (e.g., only managers can approve or delete).
* **Define responsibilities** — grant access according to job functions (e.g., yard staff manage deliveries, site users submit requests).
* **Streamline workflows** — make sure that only authorized users can approve, receive, release, or void records.
* **Improve accuracy** — prevent errors by restricting who can modify or void important documents.
* **Maintain compliance** — ensure that safety, inspection, and handover approvals come from verified roles.

***

## Accessing Permissions

You can access **Permissions** in two ways:

1. Navigate to **Settings → User Profiles → Edit Roles** **→ Click the Plus (+) or Edit Role** button **→** Set Role permissions (**Click here**).
2. Navigate to **Settings → User Profiles → Click on a user** in the user list **→**  Set Role permissions for this user (**Select role**) **→ Click the Plus (+) or Edit Role** button **→** Set Role permissions (**Click here**).

***

## Understanding the Permissions Layout

The **Permissions UI** is designed to make role setup clear and easy to understand — every section is color-coded, with tools grouped and labeled so you know what area of the system you’re applying permissions to.

***

### Section Headers (Colored Blocks)

Each major section of the system is displayed in its own **colored block** (for example, *Sites*, *Inventory*, or *Scaffolds*).

These colored sections help you quickly recognize what part of the system you’re working in.

* **Red section** — relates to **Roles** and system-level permissions.
* **Blue section** — relates to **Inventory** **Management** permissions.
* **Green section** — relates to **Site Management** (sites, scaffolds, JSPs, etc.).

Each section title (like **Sites** or **Inventory**) clearly states the module’s purpose and scope.

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FkrHeN7FfWDpNxmUdqinq%2FScreenshot%202025-11-01%20at%2015.57.16.png?alt=media&amp;token=0b7a8399-ddcd-47c3-842d-5855a8f4ac8f" alt=""><figcaption></figcaption></figure></div>

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FVaymfojDQpGj6Wytz6lB%2FScreenshot%202025-11-01%20at%2015.55.28.png?alt=media&amp;token=3a9a5890-625a-457e-aae3-b2952187a564" alt=""><figcaption></figcaption></figure></div>

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FSdMHl7bMuMEd3vLR96hV%2FScreenshot%202025-11-01%20at%2015.58.18.png?alt=media&amp;token=3bd41cf8-2545-440a-a997-642436b32a06" alt=""><figcaption></figcaption></figure></div>

***

### Section Titles and Descriptions

Within each section, you’ll find a **title** and a **short description** that explain what that part of the system controls.

These descriptions give you an overview of what the section or module is used for — for example:

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FTHU5E8aK1pGztcf6jtjz%2FScreenshot%202025-11-01%20at%2009.54.58.png?alt=media&amp;token=581c4d71-9816-42d9-8f9e-85cb7c074214" alt=""><figcaption></figcaption></figure></div>

This section holds all the permissions related to Site management.

***

### *Tool Titles and Descriptions*

Example: In the **Sites** section, you can enable permissions for managing **Deliveries** sent to a site. When enabled, users can **view**, **receive**, or **void** deliveries as needed.

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FgnsAKTMMTXtWceGgWls6%2FScreenshot%202025-11-01%20at%2009.57.04.png?alt=media&amp;token=329f0e15-9b0e-4c13-9680-a8226674928c" alt=""><figcaption></figcaption></figure></div>

> **Important:**\
> If a tool’s permission is turned **on** within a section, that section and it's active tools become visible and accessible to the user.

***

### “Select All” and “Unselect All” Buttons

At the top-right corner of each permission section, you’ll see **Select All** and **Unselect All** links.

* **Select All** enables every toggle in that section.\
  Use this when granting full access to that module.
* **Unselect All** disables every toggle.\
  Use this to reset or remove all access before reconfiguring.

These controls let you quickly manage large permission sets with one click.

{% columns %}
{% column %}

#### **Select All**

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2F4LWXnCnPccCSIjhhSs1B%2FScreenshot%202025-11-01%20at%2009.34.10.png?alt=media&amp;token=92ed2e1e-5fe7-414f-8231-70371039e955" alt="" width="188"><figcaption></figcaption></figure></div>

When clicked, **Select All** turns on every permission toggle within that section or tool.

{% endcolumn %}

{% column %}

#### **Unselect All**

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FvOA9xuKiwOAt8RWOCjew%2FScreenshot%202025-11-01%20at%2009.34.18.png?alt=media&amp;token=46bb904b-1f38-4c2e-9344-5518ba3b27fc" alt="" width="188"><figcaption></figcaption></figure></div>

When clicked, **Unselect All** turns off every permission toggle within that section or tool.
{% endcolumn %}
{% endcolumns %}

***

### Toggles

Inside each group, you’ll see **individual toggle buttons** labeled by action type:\
**Create**, **View**, **Update**, **Delete**, **Approve**, **Void**, and so on.

Each toggle controls a specific action for that feature.

When the toggle is **switched on** (orange), the user or role has permission to perform that action.

When it’s **off** (grey), that capability is disabled.

{% columns %}
{% column %}
**Toggle is OFF**

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FhghMEWt9vDs1VtMY7SF1%2FScreenshot%202025-11-01%20at%2016.06.52.png?alt=media&amp;token=7abcc7af-4eb5-4468-87dc-1120270f496c" alt="" width="99"><figcaption></figcaption></figure></div>
{% endcolumn %}

{% column %}
**Toggle is ON**

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FKAsiV9PtraDASpD9FkCE%2FScreenshot%202025-11-01%20at%2016.06.59.png?alt=media&amp;token=442388ea-709f-48a2-a631-35b599784e09" alt="" width="98"><figcaption></figcaption></figure></div>
{% endcolumn %}
{% endcolumns %}

***

### Tools

Within each section (like **Sites**), you’ll see a list of **tools** — for example, **Inventory**, **Deliveries**, or **Tasks**. Each tool includes a set of **toggles** that control specific actions, such as *Create*, *View*, *Update*, or *Void*.

When a toggle is turned **on**, that tool becomes active for the role.

When the role is then assigned to a user, the user will see and be able to use those active tools in their profile.

> **Example:**\
> If a role has the **Deliveries** tool active with *View* and *Receive* toggled on, users with that role will be able to view and receive deliveries but won’t be able to void them.&#x20;
>
> Similarly, if the **Inventory** tool is active with *View* and *Reports* toggled on, users will be able to view inventory data and generate reports but not edit or add new inventory items.

<figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FDZx7uxGRuMqi2hxCRBEO%2FPermission%20list.jpg?alt=media&amp;token=07757d66-fdc6-4da1-a205-0135613a3e18" alt=""><figcaption></figcaption></figure>

***

### Clean, Consistent Layout

Every permission card follows the same clean structure:

* **Title** – The feature or function (e.g., *Scaffolds*).
* **Subtitle** – A short explanation of what the function does.
* **Toggles** – The specific actions allowed (Create, View, Update, etc.).
* **Quick Actions** – “Select All” and “Unselect All” links for fast setup.

This consistency makes the interface easy to learn and extremely efficient when configuring multiple roles.

***

### Save & Confirmation

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FpPuDXNRV1V3GLpO2Gyzf%2FScreenshot%202025-11-02%20at%2004.35.02.png?alt=media&amp;token=1c69739f-138f-4099-a721-6753d6de9ef6" alt=""><figcaption></figcaption></figure></div>

Once your permissions are set, clicking **Select** (top right of the screen) saves the configuration.

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FShSmx6TR8yV00AvfPRuk%2FScreenshot%202025-11-02%20at%2004.35.08.png?alt=media&amp;token=1f11337b-0e8d-4d2a-a0d5-3df0faed29f9" alt="" width="96"><figcaption></figcaption></figure></div>

The role permissions are now active and will apply immediately for users assigned to that role.

If you change your mind before saving, click **Cancel** (top left) to discard changes.

<div align="left" data-with-frame="true"><figure><img src="https://3532476255-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVJ0qURLvzCOxTGXEZIZ%2Fuploads%2FFWlJr7GQbIT7zYg303dH%2FScreenshot%202025-11-02%20at%2004.36.39.png?alt=media&amp;token=e6685887-4c69-4590-b09a-f7c32f31bc9c" alt="" width="109"><figcaption></figcaption></figure></div>

***

## Permission Toggles

When adding or removing permissions, you’ll see various toggles. Each one defines what the selected role can see and do inside the system.

{% hint style="info" %}
[Learn what permission toggles mean](/settings/user-management/understanding-permission-toggles.md)
{% endhint %}
