Skip to main content

Чтение информации о группе

Метод и конечная точка​

GET /tenants/{tenant_name}/groups/{group_id}

Описание​

Запрос установленных значений параметров групп.

Параметры​

Параметры для метода указаны в таблице.

НазваниеОбязательныйТип данныхОписание
with_ctypesнетstringПеречень запретов на загрузку файлов определенных типов для группы
tenant_nameдаstringИмя тенанта
group_idдаstringИдентификационный номер группы

Запрос​

curl -X 'GET' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/groups/<GROUP_ID>?with_ctypes=<WITH_CTYPES>" \
-H 'accept: application/json'

где:

  • <TENANT_NAME> — имя тенанта;

  • <GROUP_ID> — имя новой группы;

  • <WITH_CTYPES> — возможность работы с файлами в соответствии с правилами для определенных медиатипов.

Ответ​

Возможные варианты ответов:

  • 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"
}