> For the complete documentation index, see [llms.txt](https://kb.pvhostvm.ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.pvhostvm.ru/hostvm-vdi/rest-api-guide/3.5/authentication.md).

# Аутентификация

**Аутентификация пользователя:**

**`POST /auth/login`**

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

`auth` - имя аутентификатора, тип: *string*\
`username` - имя пользователя, тип: *string*\
`password` - пароль пользователя, тип: *string*

Пример ответа в случае успешной аутентификации:

```
{'result': 'ok', 'token': 'token_value', 'version': '3.0.0', 'scrambler': 'scrambler_value'}
```

Пример ответа в случае неуспешной аутентификации:

```
{'result': 'error', 'token': None, 'version': '3.0.0', 'error': 'Invalid credentials'}
```

> **Важно:** значение параметра `token` используется в качестве значения HTTP заголовка `X-Auth-Token`, передаваемого во всех последующих запросах к API в рамках текущей сессии.

**Завершение сессии:**

**`GET /auth/logout`**