Перейти к основному содержимому
Версия: 8.3

Управление доступом к КЕ

Предоставление доступа к КЕ

POST /api/public/sm/v2/rsm/config-items/{id}/work-groups

Запрос возвращает модель обновлённой КЕ.

подсказка

Для выполнения данного запроса должен использоваться API токен со следующими условиями:

  • У пользователя, владельца API токена есть доступ на редактирование КЕ, к которой нужно предоставить доступ
  • У этого же пользователя есть доступ к РГ, которой планируется предоставить доступ, с любой ролью

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

Название параметраТип параметраОбязательный параметрЗначение по умолчаниюОписание
idintegerданетИдентификатор КЕ

Тело запроса

{
"workGroupId": 0,
"shareType": "ConfigItem",
"grants": ["read"]
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
workGroupIdintegerданетИдентификатор рабочей группы. 0 – все рабочие группы, включая будущие
shareTypestringданетТип предоставляемых прав
grantsstring[]данетПредоставляемые рабочим группам права

Коды ответов

Код ответаОписание
400Требуется указать список предоставляемых прав
400Недопустимое значение идентификатора КЕ
400Недопустимое значение идентификатора рабочей группы
400Правило доступа уже установлено
403Недостаточно прав для предоставления доступа к КЕ
404КЕ с идентификатором {id} не найдена
404Рабочая группа с идентификатором {id} не найдена

Обновление предоставления доступа к КЕ

PUT /api/public/sm/v2/rsm/config-items/{id}/work-groups/{sharedId}

Запрос возвращает модель обновлённой КЕ.

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

Название параметраТип параметраОбязательный параметрЗначение по умолчаниюОписание
idintegerданетИдентификатор КЕ
sharedIdintegerданетИдентификатор модели предоставления доступа к КЕ

Тело запроса

{
"workGroupId": 0,
"shareType": "ConfigItem",
"grants": ["read"]
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
workGroupIdintegerданетИдентификатор рабочей группы. 0 – все рабочие группы, включая будущие
shareTypestringданетТип предоставляемых прав
grantsstring[]данетПредоставляемые рабочим группам права

Коды ответов

Код ответаОписание
400Требуется указать идентификатор рабочей группы
400Требуется указать список предоставляемых прав
400Недопустимое значение идентификатора КЕ
400Недопустимое значение идентификатора модели предоставления доступа к КЕ
401Не удалось выполнить авторизацию пользователя
403Недостаточно прав для обновления предоставленного доступа к КЕ
404КЕ с идентификатором {id} не найдена
404Модель предоставления доступа к КЕ с идентификатором{id} не найдена

Удаление предоставления доступа к КЕ

DELETE /api/public/sm/v2/rsm/config-items/{id}/work-groups/{sharedId}

Запрос возвращает модель обновлённой КЕ.

Название параметраТип параметраОбязательный параметрЗначение по умолчаниюОписание
idintegerданетИдентификатор КЕ
sharedIdintegerданетИдентификатор модели предоставления доступа к КЕ

Коды ответов

Код ответаОписание
204Запрос успешно исполнен
400Недопустимое значение идентификатора КЕ
400Недопустимое значение идентификатора модели предоставления доступа к КЕ
403Недостаточно прав для удаления предоставления доступа к КЕ
404КЕ с идентификатором {id} не найдена
404Модель предоставления доступа к КЕ с идентификатором {id} не найдена

Управление стадией жизненного цикла КЕ по категории стадии ЖЦ

POST /api/public/sm/v2/rsm/config-items/{id}/stages/category

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

Название параметраТип параметраОбязательный параметрЗначение по умолчаниюОписание
idintegerданетИдентификатор КЕ

Тело запроса

{
"category": "Category",
"settings": {
"applyGrants": false
}
}

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
categorystringданетКатегория ЖЦ
settingsobjectнетnullНастройки перевода КЕ в новую стадию ЖЦ

Коды ответа

Код ответаОписание
400Стадия КЕ Deleted, переход на другую стадию жизненного цикла невозможен
400Жизненный цикл КЕ не содержит стадию, указанную для перевода
400Перевести КЕ из текущей стадии на указанную стадию невозможно
400Невозможно перевести КЕ из текущей стадии на стадию указанной категории
403Недостаточно прав для изменения КЕ
403Недостаточно прав для управления влияющей КЕ
404КЕ с идентификатором {id} не найдена

Управление стадиями жизненного цикла нескольких КЕ по категории стадии ЖЦ

POST /api/public/sm/v2/rsm/config-items/stages/category/batch

Тело запроса


[
{
"configItemId": 1,
"category": "Created",
"settings": {
"applyGrants": false
}
},
{
"configItemId": 2,
"category": "Active",
"settings": {
"applyGrants": true
}
}
]

Поля тела запроса

Название поляТип поляОбязательное полеЗначение по умолчаниюОписание поля
configItemIdintegerданетИдентификатор КЕ
categorystringданетКатегория ЖЦ
settingsobjectнетnullНастройки перевода КЕ в новую стадию ЖЦ

Коды ответа

Код ответаОписание
400Стадия КЕ Deleted, переход на другую стадию жизненного цикла невозможен
400Жизненный цикл КЕ не содержит стадию, указанную для перевода
400Перевести КЕ из текущей стадии на указанную стадию невозможно
400Невозможно перевести КЕ из текущей стадии на стадию указанной категории
403Недостаточно прав для изменения КЕ
403Недостаточно прав для управления влияющей КЕ
404КЕ с идентификатором {id} не найдена