ACL

Разработчикам / REST API для BOOCO Meteor (v 1.x) / Общее API

В этом разделе описываются методы для работы с коллекцией acl.

Endpoint	Метод	Описание	Queries	Body (JSON)	Значение поля data	Права (ресурс)	Версия
/acl/can/:action/:resource	GET	Запрос прав текущего пользователя для выполнения `:action` для `:resource`			доступ (boolean)	read:own (permission)	1.36.0
/acl/:userId/can/:action/:resource	GET	Запрос прав пользователя `:userId` для выполнения `:action` для `:resource`				read:any (permission)	1.36.2
/acl	GET	Получить все записи из коллекции acl	roleresourceacl-action		спиоск `ACLEntry[]`	read:any (permission)
/acl/:id	GET	Получить запись из коллекции acl по ключу (`key=_id` - обязательный параметр в данном запросе)	key		объект `ACLEntry`	read:any (permission)
/acl	POST	Создать новую запись в коллекции acl. Требуется заново загрузить права после выполнения этой операции (`/acl/reload`). ВАЖНО: данный метод работает напрямую с коллекцией без проверки значений. Рекомендуется использовать методы add.		объект `ACLEntry`		create:any (permission)
/acl/:id	PUT	Изменить запись из коллекции acl по ключу (`key=_id` - обязательный параметр в данном запросе). Требуется заново загрузить права после выполнения этой операции (`/acl/reload`). ВАЖНО: данный метод работает напрямую с коллекцией без проверки значений. Рекомендуется использовать методы add.	key	объект `ACLEntry`		update:any (permission)
/acl/:id	DELETE	Удалить запись из коллекции acl по ключу (`key=_id` - обязательный параметр в данном запросе). Требуется заново загрузить права после выполнения этой операции(`/acl/reload`).	key			delete:any (permission)
/acl/reload	GET	Загрузить заново права из коллекции acl.				execute:any (permission)	1.37.1 (переименоан)
/acl/add/:role/:resource	GET	Добавить доступ к `:resource` для `:role` и сохранить изменения, если не указан параметр `noSave`. Если указан параметр `own`, то добавляются действия с рамками own, иначе - any.	noSaveown			create:any (permission)update:any (permission)	1.37.1
/acl/add/:role/:action/:resource	GET	/Добавить действие `:action` для доступа к `:resource` для `:role` и сохранить изменения (если не указан параметр `noSave`).	noSave			create:any (permission)update:any (permission)	1.37.1
/acl/save	GET	Сохраняет изменения				create:any (permission)update:any (permission)	1.37.1

Name	Описание	Тип значения
action	Тип действия `ACLActionsFunc`	string
resource	Ресурс (booking, venue, …). Ресурс можно указывать с уточнением. Например, booking:meeting-room	string
userId	_id пользователя для которого выполняется запрос прав	string
id	Идентификатор записи по которому идет поиск	string
acl-action	Тип действия `ACLActionsWithColumn`	string

Queries	Описание	Тип значения	Обязательный	Значение по умолчанию
noSave	Не вызывать saveGrants по завершению. Обычно используется чтобы добавить несколько ролей, а потом все сохранить.	boolean	нет	false
own	Если указан, то добавляются действия с рамками own, иначе - any.	boolean	нет	false

Используемые типы

type ACLActionsWithColumn = 'read:any' | 'read:own' | 'create:any' | 'create:own' | 'update:any' | 'update:own'
| 'delete:any' | 'delete:own' | 'execute:any' | 'execute:own';

type ACLActionsFunc = 'readAny' | 'readOwn' | 'createAny' | 'createOwn' | 'updateAny' | 'updateOwn'
| 'deleteAny' | 'deleteOwn' | 'executeAny' | 'executeOwn';

export type ACLEntry = {
  _id: string,
  role: string,
  resource: string,
  action: ACLActionsWithColumn,
  attributes: [string]
};

ACL

Endpoints

Параметры URL

Параметры запроса (Queries)

Используемые типы