Создание новой группы пользователей
Метод и конечная точка
POST /tenants/{tenant_name}/groups
Описание
Создать новую группу пользователей.
Параметры
Параметры для метода указаны в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| name | да | string | Имя новой группы |
| users | нет | string | Перечень идентификационных номеров пользователей добавляемых в группу |
| tenant_name | да | string | Имя тенанта |
Запрос
curl -X 'POST' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/groups?name=<NEW_GROUP_NAME>&users=<USER_ID>" \
-H 'accept: application/json'
где:
-
<TENANT_NAME>— имя тенанта; -
<NEW_GROUP_NAME>— имя новой группы; -
<USER_ID>— идентификационные номера пользователей добавляемых в группу.
Ответ
Возможные варианты ответов:
- 200 — Success — Успешно. Пример вывода:
{
"groups": [
{
"ctypes": [
{
"grouped_ctype": "string",
"prohibited": true
}
],
"id": 0,
"name": "string",
"subgroups": [
{
"id": 0,
"name": "string"
}
],
"users":[
{
"first_name": "string",
"id": "string",
"last_name": "string",
"middle_name": "string",
"username": "string"
}
]
}
]
}
- 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}
- 409 — Group with such name already exists — Группа с таким именем уже существует. Пример вывода:
{
"message": "string"
}