> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/roles.md).

# Roles

Manage roles for **Tier 1 users in your Mimeeq account**. A role groups the permissions that control what an account user can view or change in the Mimeeq admin app.

These endpoints manage Tier 1 account roles. They do not manage Tier 2 dealer or partner roles.

### What you can do

| Task                                             | Operation                                                                               |
| ------------------------------------------------ | --------------------------------------------------------------------------------------- |
| Find existing roles                              | [List Roles](https://help.mimeeq.com/developers/roles/list-roles)                       |
| Discover available permission identifiers        | [List Role Permissions](https://help.mimeeq.com/developers/roles/list-role-permissions) |
| Read a role and its assigned users               | [Get Role](https://help.mimeeq.com/developers/roles/get-role)                           |
| Add a role with permissions and user assignments | [Create Role](https://help.mimeeq.com/developers/roles/create-role)                     |
| Change a role or its assignments                 | [Update Role](https://help.mimeeq.com/developers/roles/update-role)                     |

### Before you start

Your API key needs `roles:read` to read roles and available permissions, or `roles:write` to create or update them. API-key scopes control which API requests your integration can make. Role permissions control what the assigned users can do in Mimeeq.

To assign users, use user IDs returned by [List Users](https://help.mimeeq.com/developers/users/list-users) for the same Mimeeq account.

### Updating user assignments

> **The supplied user list replaces the current assignments.** Include every user you want to keep. Send an empty `userIds` array to remove all assignments, or omit `userIds` to leave them unchanged.

Start with Get Role, prepare the complete list of users, and then submit Update Role. A new role is inactive unless you set its status to `ACTIVE`.


---

# 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://help.mimeeq.com/api/roles.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.