# Roles

The "Roles" tab is intended for configuring user access rights to the tools of Sherpa AI Server. The number of roles that can be created is unlimited.

<table data-header-hidden><thead><tr><th width="55.77777099609375"></th><th width="260.66668701171875"></th><th valign="top"></th></tr></thead><tbody><tr><td><strong>No.</strong></td><td><strong>Interface Element</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td>1.</td><td>"Create" button</td><td valign="top">Allows creating new Roles.</td></tr><tr><td>2.</td><td>"Refresh" button</td><td valign="top">Forces the "Roles" table to refresh.</td></tr><tr><td>3.</td><td>"Delete Selected" button</td><td valign="top">Allows deleting selected Roles from Sherpa AI Server. Individual Roles can also be deleted by clicking the button in the corresponding row of the "Roles" table. A confirmation window appears when deleting Roles.</td></tr><tr><td>4.</td><td>"Export to CSV" button</td><td valign="top">Generates a Roles data file in CSV (Comma-Separated Values) format for importing into spreadsheets and accounting systems.</td></tr><tr><td>5.</td><td>"Export to XLSX" button</td><td valign="top">Generates a Roles data file in Microsoft Excel (XLSX) format for importing into spreadsheets and accounting systems.</td></tr><tr><td>6.</td><td>"Name" column</td><td valign="top">The name of the Role in Sherpa AI Server.</td></tr><tr><td>7.</td><td>"Description" column</td><td valign="top">Description of the Role, containing information about the purpose of the Role.</td></tr><tr><td>8.</td><td>"Access" column</td><td valign="top">List of access rights for the Role indicating permissions (Create/Read/Update/Delete) for the following tools: Licenses, Accounts, Roles, Users, API, Audit, Object Folders, Documents, Chat History, Chat GPT, Assistants, Models, Moderation.</td></tr></tbody></table>

## Create Role

To create a new Role, click the "Create" button in the "Roles" table and fill out the form that appears in the "Role" popup window.

Fields and checkboxes to fill out in the "Role" popup window:

1. The "Main" tab includes fields:

* Name\* – a mandatory field for entering the role name;
* Description – a field for entering the role description.

2. The "Access" tab includes checkboxes:

* Licenses:
  * Create – allows the creation of new licenses;
  * Read – allows viewing the list of licenses and their properties;
  * Update – allows editing existing licenses;
  * Delete – allows deleting licenses;
* Accounts:
  * Create – allows the creation of new accounts;
  * Read – allows viewing the list of accounts and their properties;
  * Update – allows editing existing accounts;
  * Delete – allows deleting accounts;
* Roles:
  * Create – allows the creation of new roles;
  * Read – allows viewing the list of roles and their properties;
  * Update – allows editing existing roles;
  * Delete – allows deleting roles;
* Users:
  * Create – allows the creation of new users;
  * Read – allows viewing the list of users and their properties;
  * Update – allows editing existing users;
  * Delete – allows deleting users;
* API:
  * Create – allows the creation of new APIs;
  * Read – allows viewing the list of APIs;
  * Update – allows editing existing APIs;
  * Delete – allows deleting APIs;
* Audit:
  * Create – allows the creation of audit records;
  * Read – allows viewing the audit log;
  * Update – allows editing audit records;
  * Delete – allows deleting audit records;
* Object Folders:
  * Create – allows the creation of new access folders;
  * Read – allows viewing the structure and properties of access folders;
  * Update – allows editing the properties of access folders;
  * Delete – allows deleting access folders;
* Documents:
  * Create – allows the creation of new documents;
  * Read – allows viewing the list of documents and their content;
  * Update – allows editing existing documents;
  * Delete – allows deleting documents;
* Chat History:
  * Create – allows the creation of chat history records;
  * Read – allows viewing chat history;
  * Update – allows editing chat history records;
  * Delete – allows deleting chat history records;
* Chat GPT:
  * Create – allows the creation of GPT chat sessions;
  * Read – allows viewing GPT chat history;
  * Update – allows editing GPT chat settings;
  * Delete – allows deleting GPT chat sessions;
* Assistants:
  * Create – allows the creation of new assistants;
  * Read – allows viewing the list of assistants and their properties;
  * Update – allows editing existing assistants;
  * Delete – allows deleting assistants;
* Models:
  * Create – allows adding new AI models;
  * Read – allows viewing the list of available AI models;
  * Update – allows editing AI model settings;
  * Delete – allows deleting AI models;
* Moderation:
  * Create – allows the creation of moderation rules;
  * Read – allows viewing the list of moderation rules;
  * Update – allows editing moderation rules;
  * Delete – allows deleting moderation rules.

<figure><img src="https://3237142148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FscP4BXwl9ufpJr5mfVln%2Fuploads%2Fgit-blob-89fc6091d9e46e3ae48c8cd2944862308bed5510%2F2026-03-24_16-43-13.png?alt=media" alt=""><figcaption></figcaption></figure>

3. The "Object Folders" tab includes checkboxes that define specific access folders to which the role is granted. Available folders for selection are displayed as a hierarchy tree.\
   Checkbox structure:
   1. The checkbox for the root folder automatically grants access to all nested folders;
   2. The checkbox for a nested folder grants access only to that folder.

<figure><img src="https://3237142148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FscP4BXwl9ufpJr5mfVln%2Fuploads%2Fgit-blob-3805a947f2cb906ea1cbbd69ef7b4e94a75b52fe%2F2026-03-24_17-34-58.png?alt=media" alt=""><figcaption></figcaption></figure>

## Edit Role

To view and edit a Role, select it from the list and click the icon ![](https://3237142148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FscP4BXwl9ufpJr5mfVln%2Fuploads%2Fgit-blob-8f5f4782ac14b216a277cbb1648ebc6acd50acf1%2Fimage%20\(70\).png?alt=media). After that, the Role editing form will open, where necessary changes can be made.

In the "Main" tab, in addition to the fields filled in when creating the Role, the form shows the GUID (unique identifier assigned to the role after its creation). This field cannot be edited.

In the "Access" tab, all objects and operations allowed for this Role can be checked.

<figure><img src="https://3237142148-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FscP4BXwl9ufpJr5mfVln%2Fuploads%2Fgit-blob-b838df360e885f18025a1b636a7ec7fcefc16289%2F2025-08-07_18-12-41%20(1).png?alt=media" alt=""><figcaption></figcaption></figure>

In the "Object Folders" tab, access folders that are allowed for this Role can be checked.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sherparpa.ru/en/sherpa-ai/sherpa-ai-server/rabota-v-sherpa-ai-server/roli.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.