1. Saby
  2. База знаний
  3. API
  4. API Система прав
  5. sabyRole.Read

sabyRole.Read

sabyRole.Read

Метод возвращает информацию о роли: название, описание, родительские роли.

Параметры запроса

Параметр
* — обязательный

Тип

Описание

Role*

объект

параметры для поиска роли

 

RoleId

строка
UUID

внутренний идентификатор роли

ExtRoleId

строка

внешний идентификатор роли

RoleName

строка

название роли

Результат

Параметр

Тип

Описание

Role

объект

параметры для поиска роли

 

RoleId

строка
UUID

внутренний идентификатор роли

ExtRoleId

строка

внешний идентификатор роли

RoleName

строка

название роли

Description

строка

описание роли

IsHidden

логическое

признак, что роль скрыта или используется для удаленных системных ролей

IsSystem

логическое

признак, что роль является системной

ParentsRoles

массив объектов

роли, от которых наследуются доступы для текущей роли

 

RoleId

строка
UUID

внутренний идентификатор роли

ExtRoleId

строка

внешний идентификатор роли

RoleName

строка

название роли

Folder

объект

папка, в которой находится роль

 

FolderId

строка
UUID

внутренний идентификатор папки

FolderName

строка

название папки

Position

объект

должность, связанная с должностной ролью

 

ID

строка
UUID

внешний идентификатор должности

Title

строка

название должности

Clarification

строка

описание должности

Примеры

Запрос

Результат

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.