# Аутентификаторы, группы и пользователи
## Запрос текущей конфигурации
Получение списка аутентификаторов:
**`GET /authenticators`**
Получение параметров аутентификатора:
**`GET /authenticators/{auth_id}`**
Получение списка созданных в аутентификаторе групп:
**`GET /authenticators/{auth_id}/groups`**
Получение параметров группы аутентификатора:
**`GET /authenticators/{auth_id}/groups/{group_id}`**
Получение списка созданных в аутентификаторе пользователей:
**`GET /authenticators/{auth_id}/users`**
Получение параметров пользователя:
**`GET /authenticators/{auth_id}/users/{user_id}`**
Получение списка пользователей группы:
**`GET /authenticators/{auth_id}/groups/{group_id}/users`**
### Параметры path
`{auth_id}` - id аутентификатора
`{group_id}` - id группы
`{user_id}` - id пользователя
### Примеры
Пример ответа с параметрами аутентификатора (Active Directory):
```
{
'numeric_id': 14,
'id': 'ac0702cd-cb63-5ea1-b6a6-ae3d5adff46d',
'name': 'dc1',
'tags': [],
'comments': '',
'priority': 2,
'visible': True,
'small_name': 'dc1',
'users_count': 1,
'type': 'ActiveDirectoryAuthenticator',
'type_name': 'Active Directory Authenticator',
'type_info': {
'canSearchUsers': True,
'canSearchGroups': True,
'needsPassword': False,
'userNameLabel': 'User name',
'groupNameLabel': 'Group name',
'passwordLabel': 'Password',
'canCreateUsers': True,
'isExternal': True
},
'permission': 96,
'host': '10.1.1.1',
'ssl': False,
'username': 'user@domain.local',
'password': 'password',
'timeout': '10',
'ldapBase': 'dc=domain,dc=local',
'groupBase': '',
'defaultDomain': '',
'nestedGroups': False
}
```
Пример ответа с параметрами группы:
```
{
'id': '71326643-3aba-5f20-9717-a09c44a5540a',
'name': 'Domain Admins',
'comments': '',
'state': 'A',
'type': 'group',
'meta_if_any': False,
'pools': ['d1bd5dff-5287-5afd-9444-493a3528a535']
}
```
Пример ответа с параметрами пользователя:
```
{
'name': 'vdiuser',
'real_name': 'vdiuser',
'comments': '',
'state': 'A',
'staff_member': False,
'is_admin': False,
'last_access': 1603712668,
'parent': None,
'id': 'e954f545-4870-5da2-8a95-271c0e930d3f',
'role': 'User'
}
```
## Создание нового аутентификатора
Создание нового аутентификатора:
**`PUT /authenticators`**
### Параметры тела запроса
`name` - имя аутентификатора, тип: *string*
`small_name` - метка, тип: *string*
`tags` - тэги для этого элемента, тип: *list of strings*
`comments` - комментарии для этого элемента, тип: *string*
`priority` - приоритет аутентификатора, тип: *integer*
`visible` - видимость аутентификатора, тип: *boolean*
`data_type` - тип аутентификатора, тип: *string*
Допустимые значения параметра `data_type`:
* `ActiveDirectoryAuthenticator` - аутентификатор Active Directory
* `InternalDBAuth` - аутентификатор Internal Database
* `SimpleLdapAuthenticator` - аутентификатор Simple LDAP
* `RegexLdapAuthenticator` - аутентификатор Regex LDAP
* `SAML20Authenticator` - аутентификатор SAML
* `RadiusAuthenticator` - аутентификатор Radius
* `IPAuth` - аутентификатор IP
**Важно:** в зависимости от выбранного типа аутентификатора, список дополнительно требуемых параметров будет отличаться. Описание см. в [приложении](/hostvm-vdi/rest-api-guide/3.5/appendix.md).
## Создание группы аутентификатора
Создание группы аутентификатора:
**`PUT /authenticators/{auth_id}/groups`**
### Параметры path
`{auth_id}` - id аутентификатора
### Параметры тела запроса
`type` - тип группы, тип: *string*
Допустимые значения параметра `type`:
* `group` - группа
* `meta` - метагруппа
`name` - имя группы, тип: *string*
`comments` - комментарии для этого элемента, тип: *string*
`state` - статус группы, тип: *string*. При создании используйте статус `A` (Active). Перечень остальных значений параметра `state` см. в [приложении](/hostvm-vdi/rest-api-guide/3.5/appendix.md).
`meta_if_any` - режим сопоставления, тип: *boolean*. Значение, отличное от `False`, учитывается только для групп типа `meta`.
`pools` - список id сервис-пулов, в которые добавлена группа, тип: *list of strings*
## Создание пользователя аутентификатора
Создание пользователя аутентификатора:
**`PUT /authenticators/{auth_id}/users`**
### Параметры path
`{auth_id}` - id аутентификатора
### Параметры тела запроса
`name` имя пользователя - , тип: *string*
`real_name` - реальное имя пользователя, тип: *string*
`comments` - комментарии для этого элемента, тип: *string*
`state` - статус пользователя, тип: *string*. При создании используйте статус `A` (Active). Перечень остальных значений параметра `state` см. в [приложении](/hostvm-vdi/rest-api-guide/3.5/appendix.md).
`staff_member` - признак наличия полномочий типа "Оператор", тип: *boolean*. Дополнительно см. параметр `role`.
`is_admin` - признак наличия полномочий типа "Администратор", тип: *boolean*. Дополнительно см. параметр `role`.
`groups` - список id групп, в которые добавлен пользователь, тип: *list of strings*
`role` - роль пользователя, тип: *string*
Допустимые значения параметра `role`:
* `admin` - администратор. Значения параметров `is_admin` и `staff_member` должны быть установлены в `True`.
* `staff` - оператор. Значение параметра `is_admin` должно быть установлено в `False`, параметра `staff_member` - в `True`.
* `user` - пользователь. Значения параметров `is_admin` и `staff_member` должны быть установлены в `False`.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://kb.pvhostvm.ru/hostvm-vdi/rest-api-guide/3.5/authenticators.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.