Пользовательская группа (group)

Содержание

Описание
Поля
См. также
- API

Описание

Определяет наборы ролей. Включает в себя пользователей. Может включать в себя другие группы (без циклов).
При настроенных группах пользователя достаточно включить в одну из них - роли для него определятся автоматически.
Тем не менее, роль администратора (admin) должна быть задана непосредственно как минимум одному из пользователей домена.

Поля

Структура сущности

{
  "id": uuid,
  "code": str,
  "description": str,
  "users": array<str>,
  "groups": array<str>,
  "opts": {
    "title": str,
    "comment": str,
    "roles": array<str>
  },
  "security": object,
  "ext": {
    "ct": date,
    "lwt": date
  }
}

Описание характеристик спецификации

Table 1. Поля
Спецификация	Описание
Поле: `id` Режим: `inout` Тип: `uuid` По умолчанию: generated	Идентификатор. Может быть задан при создании, иначе генерируется системой.
Поле: `code` Режим: `in` Тип: `str` По умолчанию: required	Строковый код группы
Поле: `description` Режим: `in` Тип: `str` По умолчанию: empty	Описание
Поле: `users` Режим: `in` Тип: `array` По умолчанию: empty	Список входящих в группу пользователей. Задаются идентификаторами. Через API поддерживается указание логинов при создании, автоматически разворачиваются в идентификаторы.
Поле: `groups` Режим: `in` Тип: `array` По умолчанию: empty	Список вложенных пользовательских групп. Задаются идентификаторами. Через API поддерживается указание кодов групп при создании, автоматически разворачиваются в идентификаторы.
Поле: `opts` Режим: `in` Тип: `object` Составное поле
Поле: `opts.title` Режим: `in` Тип: `str` По умолчанию: empty	Произвольный заголовок
Поле: `opts.comment` Режим: `in` Тип: `empty` По умолчанию: "	Произвольный комментарий
Поле: `opts.roles` Режим: `in` Тип: `array<str>` По умолчанию: empty	Список ролей группы, наследуемых всеми входящими в нее пользователями. Возможные значения доступны через API roles. Через API при создании поддерживается указание в виде строки через запятую. Полный набор ролей группы определяется также вхождением группы в другие группы. Весь набор заданных группам ролей доступен через API groups_caches.
Поле: `security` Режим: `inout` Тип: `object` Составное поле	Позволяет расширять состав произвольными ключами и значениями.
Поле: `ext` Режим: `inout` Тип: `object` Составное поле	Позволяет расширять состав произвольными ключами и значениями.
Поле: `ext.ct` Режим: `out` Тип: `date` По умолчанию: generated	Время создания объекта
Поле: `ext.lwt` Режим: `out` Тип: `date` По умолчанию: generated	Время последней модификации объекта

См. также

API

/rest/v1/domain/roles