> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-users.md).

# Users (multi-site)

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). Platforms: web. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/console/multi-site-users.md).
{% endhint %}

A multi-site user makes people multi-site users, chooses which of the multi-site's sites each person can open and with which role, and manages their groups and devices.

![Users (multi-site)](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-c78ef31e0b41b2a5d6d94f07d9bc3706e1835752%2Fmulti-site-users.png?alt=media)

* **Where:** web `/multi-site/users` (Multi-Site Console, tab "Users").
* **Who:** anyone with a multi-site selected in the site switcher. Every viewer gets every control, and the server checks only membership of the multi-site, not a role in it \[[ASK-123](https://github.com/snapfix/docs/blob/main/ASK.md#ask-123-who-may-manage-a-multi-site-and-change-its-members-site-roles)].
* **Feature:** [Multi-Site Console](https://docs.snapfix.com/product/features/console/multi-site-console.md)

The page reuses the parts of the Site Console's [Users](https://docs.snapfix.com/how-the-apps-work/screens/console/users.md) page; this doc covers what differs.

## Layout

1. **Console header.** The Multi-Site Console header and tabs ([My sites](https://docs.snapfix.com/how-the-apps-work/screens/console/my-sites.md#layout)).
2. **Left column (one third).** The users of the multi-site's sites, with the tabs "Active" and "Invited" (the open tab shows its count), "Search users", and the "+" button (title "Add New Users"). The rows show the badges "ADMIN", "CONTRACTOR" and "MULTI-SITE" as on [Users](https://docs.snapfix.com/how-the-apps-work/screens/console/users.md#web). The "Invited" tab lists the invitations of the site stored as current, not of the whole multi-site, and does not name the site.
3. **Right column, header.** Photo, name, sign-in email and phone, the activity line, and the checkbox "Make a Multi-site Admin". The Site Console's "Make a Site Admin", "Remove User" and invite buttons do not show here.
4. **Access card.** Tabs "Sites (N)", where N is the number of sites in the multi-site, not the user's; "Groups", enabled once the user has saved sites; and "Devices", the same as on [Users](https://docs.snapfix.com/how-the-apps-work/screens/console/users.md#web).

## Inputs

| Field                     | Type                    | Required         | Default                                                         | Rules and messages                                                                                                                                                                                        |
| ------------------------- | ----------------------- | ---------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Search users"            | Text                    | No               | Empty                                                           | Asks the server; matches names, the sign-in email, the phone number or the user ID.                                                                                                                       |
| "Make a Multi-site Admin" | Checkbox                | No               | Ticked for a multi-site user                                    | Adds or removes the multi-site membership, after a popup. It sets a plain membership, which the add popup calls the "Multi-site view role"; there is no multi-site admin role. Not shown for contractors. |
| Sites tab: "Select All"   | Checkbox                | No               | Off                                                             | Disabled on the signed-in user's own row and while saving.                                                                                                                                                |
| Sites tab: site           | Checkbox per site       | No               | The user's live sites                                           | Disabled on the signed-in user's own row and while saving.                                                                                                                                                |
| Sites tab: role           | Menu per ticked site    | Yes, once ticked | "Multi-site View" for a multi-site user, "User" for anyone else | A multi-site user: "Multi-site View" or "Site Admin". Anyone else: "User" or "Site Admin".                                                                                                                |
| Groups tab: site          | Sites dropdown          | Yes              | The first saved site                                            | Only the sites saved on the Sites tab.                                                                                                                                                                    |
| Groups tab: group         | Checkbox per task group | No               | Current membership                                              | The picked site's live task groups, with "Select All" and a search.                                                                                                                                       |
| Groups tab: role          | Menu per ticked group   | Yes, once ticked | "User" for a new group                                          | A multi-site user: "Group Admin" or "Multi-site View". Anyone else: "Group Admin" or "User".                                                                                                              |

## Actions

| Action                           | Who              | What happens                                                                                                                                                                                                                                                                                  | API                                                                                                                                                                                                                                                                                                                                                               |
| -------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List the users                   | Multi-site users | The users of every site in the multi-site, 50 at a time, with the search text.                                                                                                                                                                                                                | [`GET /multisite/{multisiteUUID}/users`](https://docs.snapfix.com/engineering-reference/api/console.md#get-multisitemultisiteuuidusers)                                                                                                                                                                                                                           |
| Open a user                      | Multi-site users | Shows the header and loads the user's role on each site; the Groups tab is enabled when the user has sites.                                                                                                                                                                                   | [`GET /multisite/{multisiteUUID}/user/{userUUID}/sites`](https://docs.snapfix.com/engineering-reference/api/console.md#get-multisitemultisiteuuiduseruseruuidsites)                                                                                                                                                                                               |
| Tick "Make a Multi-site Admin"   | Multi-site users | "Add a new Multi-site user"; "Yes" adds the membership and reloads the list.                                                                                                                                                                                                                  | [`POST /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#post-multisitemultisiteuuiduseruseruuid) with no body                                                                                                                                                                                           |
| Untick "Make a Multi-site Admin" | Multi-site users | "Delete a Multi-site user"; "Yes" removes the membership and the user's site rows on the multi-site's sites, except site admin rows \[[ASK-127](https://github.com/snapfix/docs/blob/main/ASK.md#ask-127-should-removing-a-user-from-a-multi-site-also-remove-the-site-admin-roles-it-gave)]. | [`DELETE /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#delete-multisitemultisiteuuiduseruseruuid) with no body                                                                                                                                                                                       |
| Save sites                       | Multi-site users | Sets the roles of the ticked sites ("Site Admin" as `site-admin`, the others as `site-viewonly`) and removes the user from the unticked ones; both requests run together when both kinds of change exist. "Cancel" restores the saved sites.                                                  | [`POST /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#post-multisitemultisiteuuiduseruseruuid) with the sites; [`DELETE /multisite/{multisiteUUID}/user/{userUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#delete-multisitemultisiteuuiduseruseruuid) with the unticked sites |
| Save groups                      | Multi-site users | Adds, removes and re-roles the user's groups on the picked site.                                                                                                                                                                                                                              | [Users API](https://docs.snapfix.com/engineering-reference/api/users.md); role changes in the [Groups API](https://docs.snapfix.com/engineering-reference/api/groups.md)                                                                                                                                                                                          |
| Devices                          | Multi-site users | Block and unblock, as on [Users](https://docs.snapfix.com/how-the-apps-work/screens/console/users.md#actions).                                                                                                                                                                                | [Users API](https://docs.snapfix.com/engineering-reference/api/users.md)                                                                                                                                                                                                                                                                                          |
| Add New Users                    | Multi-site users | The [Add New Users](https://docs.snapfix.com/how-the-apps-work/screens/console/users.md#add-new-users-web) dialog, with a site picker for each person.                                                                                                                                        | [Users API](https://docs.snapfix.com/engineering-reference/api/users.md)                                                                                                                                                                                                                                                                                          |

Sites, roles and saves on this page are matched by site name, so two sites with the same name share one checkbox and one role.

## States

* **Loading:** spinners in the list, the header and each access tab.
* **Empty:** "No data available" in the list, the sites and the groups.
* **Error:** a failed save shows the API's message. A failed membership change also puts the checkbox back. A failed list load shows nothing.
* **No permission:** none inside the page. The signed-in user cannot change their own sites.

## Dialogs and sheets

* **Add a new Multi-site user:** "By assigning this user the Multi-site view role, they will be able to access and manage data across multiple sites.", "If the user previously had an Admin role in any specific site or group, they will retain that role." and "Do you want to assign this user to a multi-site role?", with "Cancel", "Yes" and a close icon. "Cancel" puts the checkbox back.
* **Delete a Multi-site user:** "This user has a Multi-site role with access and permissions to edit data from multiple sites." and "Do you want to delete this user?", with "Cancel" and "Yes". "Cancel" puts the checkbox back.
* **Add New Users, devices:** as on [Users](https://docs.snapfix.com/how-the-apps-work/screens/console/users.md#dialogs-and-sheets).

## Platform differences

Web only. The apps have no multi-site user management.


---

# 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.snapfix.com/how-the-apps-work/screens/console/multi-site-users.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.
