Управление доступом к КЕ
Раздел описывает функции контроля доступа к конфигурационным единицам, включающие получение перечня рабочих групп, назначение и корректировку разрешений, а также их отзыв с учетом расширенных настроек.
Общие функции
GetWorkGroups
Назначение: Получение доступных рабочих групп
Описание: Функция выполняет запрос к API [GET] /api/public/sm/v2/rsm/work-groups и возвращает список доступных рабочих групп.
Для работы функции GetWorkGroups требуется указать BearerToken пользователя с доступом на чтение всех РГ, так как системный токен не позволяет получить список доступных рабочих групп.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| WorkGroups | Struct: Automaton.CMDB.WorkGroup (array) | Возвращает список моделей доступных рабочих групп |
Функции управления доступом
CreateConfigItemPublicationBatch
Назначение: Предоставление доступа к КЕ
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/publications/batch для предоставления доступа другим РГ к КЕ текущей РГ.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| Publications | Struct: Automaton.CMDB.ConfigItemPublicationPost (array) | Модель запроса, в которой указываются id публикуемой КЕ и id РГ, в которую выполняется публикация |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Publications | Struct: Automaton.CMDB.ConfigItemPublication (array) | Массив моделей выполненных публикаций |
DeleteConfigItemPublicationBatch
Назначение: Удаление предоставленного доступа к КЕ
Описание: Функция выполняет запрос к API [DELETE] /api/public/sm/v2/rsm/config-items/publications/batch для удаления предоставленного доступа к КЕ.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| Publications | Struct: Automaton.CMDB.ConfigItemPublicationDelete (array) | Модель запроса, в которой указываются id КЕ и id РГ удаляемой публикации |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций |
FilterConfigItemPublications
Назначение: Получение опубликованных КЕ по фильтру
Описание: Функция выполняет запрос к API [POST] /api/public/sm/v2/rsm/config-items/published/filter для получения списка моделей КЕ, которые были опубликованы другим рабочим группам.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| Paging | Struct: Automaton.Core.PagingModel | Модель постраничного запроса, с возможностью указать дополнительные параметры фильтрации (см. подсказку) |
| FieldMask | String | Маска возвращаемых полей (см. подсказку) |
| OwnerWorkGroupIds | Integer64 (Array) | Идентификаторы РГ-владельцев |
| PublishedToWorkGroupIds | Integer64 (Array) | Идентификаторы РГ, которым опубликованы КЕ |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| ConfigItems | Struct: Automaton.CMDB.ConfigItemExtended (array) | Возвращает список моделей полученных КЕ по фильтру |
BearerToken автоматона не позволяет получать список опубликованных КЕ для РГ, отличных от РГ сценария.
Поэтому если требуется получить список опубликованных КЕ для других РГ, необходимо использовать личный токен пользователя с достаточными в соответствующих РГ правами.
- чтобы найти КЕ, опубликованные моей РГ для других:
OwnerWorkGroupIds— передатьidмоей РГPublishedToWorkGroupIds- null (не подключать пин)
- чтобы найти КЕ, опубликованные для моей РГ:
OwnerWorkGroupIds— null (не подключать пин)PublishedToWorkGroupIds— передатьidмоей РГ
Дополнительно
FieldMask
Позволяет облегчить запрос к API путем указания только нужных полей в ответе.
Представляет собой строку с названиями полей, разделяемые запятой, например: id,name,configItems.
Значения полей указываются в camelCase и являются регистрозависимыми.
Структура модели ответа остается неизменной.
Если поле FieldMask не заполнено, будет возвращена полная модель КЕ, со всеми значениями полей.
Paging
Если пин не подключен и не настроен, в результат будет выведено не более 1000 публикаций. Чтобы получить все результаты, в пин Paging → PerPage необходимо указать -1