Управление доступом к КЕ
Предоставление доступа к КЕ
POST /api/public/sm/v2/rsm/config-items/{id}/work-groups
Запрос возвращает модель обновлённой КЕ.
подсказка
Для выполнения данного запроса должен использоваться API токен со следующими условиями:
- У пользователя, владельца API токена есть доступ на редактирование КЕ, к которой нужно предоставить доступ
- У этого же пользователя есть доступ к РГ, которой планируется предоставить доступ, с любой ролью
Параметры запроса
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание |
|---|---|---|---|---|
| id | integer | да | нет | Идентификатор КЕ |
Тело запроса
{
"workGroupId": 0,
"shareType": "ConfigItem",
"grants": ["read"]
}
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| workGroupId | integer | да | нет | Идентификатор рабочей группы. 0 – все рабочие группы, включая будущие |
| shareType | string | да | нет | Тип предоставляемых прав |
| grants | string[] | да | нет | Предоставляемые рабочим группам права |
Коды ответов
| Код ответа | Описание |
|---|---|
| 400 | Требуется указать список предоставляемых прав |
| 400 | Недопустимое значение идентификатора КЕ |
| 400 | Недопустимое значение идентификатора рабочей группы |
| 400 | Правило доступа уже установлено |
| 403 | Недостаточно прав для предоставления доступа к КЕ |
| 404 | КЕ с идентификатором {id} не найдена |
| 404 | Рабочая группа с идентификатором {id} не найдена |
Обновление предоставления доступа к КЕ
PUT /api/public/sm/v2/rsm/config-items/{id}/work-groups/{sharedId}
Запрос возвращает модель обновлённой КЕ.
Параметры запроса
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание |
|---|---|---|---|---|
| id | integer | да | нет | Идентификатор КЕ |
| sharedId | integer | да | нет | Идентификатор модели предоставления доступа к КЕ |
Тело запроса
{
"workGroupId": 0,
"shareType": "ConfigItem",
"grants": ["read"]
}
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| workGroupId | integer | да | нет | Идентификатор рабочей группы. 0 – все рабочие группы, включая будущие |
| shareType | string | да | нет | Тип предоставляемых прав |
| grants | string[] | да | нет | Предоставляемые рабочим группам права |
Коды ответов
| Код ответа | Описание |
|---|---|
| 400 | Требуется указать идентификатор рабочей группы |
| 400 | Требуется указать список предоставляемых прав |
| 400 | Недопустимое значение идентификатора КЕ |
| 400 | Недопустимое значение идентификатора модели предоставления доступа к КЕ |
| 401 | Не удалось выполнить авторизацию пользователя |
| 403 | Недостаточно прав для обновления предоставленного доступа к КЕ |
| 404 | КЕ с идентификатором {id} не найдена |
| 404 | Модель предоставления доступа к КЕ с идентификатором{id} не найдена |
Удаление предоставления доступа к КЕ
DELETE /api/public/sm/v2/rsm/config-items/{id}/work-groups/{sharedId}
Запрос возвращает модель обновлённой КЕ.
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание |
|---|---|---|---|---|
| id | integer | да | нет | Идентификатор КЕ |
| sharedId | integer | да | нет | Идентификатор модели предоставления доступа к КЕ |
Коды ответов
| Код ответа | Описание |
|---|---|
| 204 | Запрос успешно исполнен |
| 400 | Недопустимое значение идентификатора КЕ |
| 400 | Недопустимое значение идентификатора модели предоставления доступа к КЕ |
| 403 | Недостаточно прав для удаления предоставления доступа к КЕ |
| 404 | КЕ с идентификатором {id} не найдена |
| 404 | Модель предоставления доступа к КЕ с идентификатором {id} не найдена |
Управление стадией жизненного цикла КЕ по категории стадии ЖЦ
POST /api/public/sm/v2/rsm/config-items/{id}/stages/category
Параметры запроса
| Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание |
|---|---|---|---|---|
| id | integer | да | нет | Идентификатор КЕ |
Тело запроса
{
"category": "Category",
"settings": {
"applyGrants": false
}
}
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| category | string | да | нет | Категория ЖЦ |
| settings | object | нет | 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
}
}
]
Поля тела запроса
| Название поля | Тип поля | Обязательное поле | Значение по умолчанию | Описание поля |
|---|---|---|---|---|
| configItemId | integer | да | нет | Идентификатор КЕ |
| category | string | да | нет | Категория ЖЦ |
| settings | object | нет | null | Настройки перевода КЕ в новую стадию ЖЦ |
Коды ответа
| Код ответа | Описание |
|---|---|
| 400 | Стадия КЕ Deleted, переход на другую стадию жизненного цикла невозможен |
| 400 | Жизненный цикл КЕ не содержит стадию, указанную для перевода |
| 400 | Перевести КЕ из текущей стадии на указанную стадию невозможно |
| 400 | Невозможно перевести КЕ из текущей стадии на стадию указанной категории |
| 403 | Недостаточно прав для изменения КЕ |
| 403 | Недостаточно прав для управления влияющей КЕ |
| 404 | КЕ с идентификатором {id} не найдена |