# auth

Описание: авторизовать текущее подключение.

Команда используется для авторизации несколькими режимами управления для каждого типа защиты.

Пример запроса (Авторизация без защиты):

{
    "method" : "auth",
    "requestId" : "1",
    "type" : "unsecured",
    "role" : "admin"
}

Пример запроса (Защищенная авторизация):

{
    "method" : "auth",
    "requestId" : "1",
    "type" : "secured",
    "credentials" : "some very secret string",
    "role" : "user"
}

Пример запроса (Переход в пользователя из-под администратора):

{
    "method" : "auth",
    "requestId" : "1",
    "role" : "user"
}

Пример ответа:

{
    "method": "auth",
    "requestId" : "1",
    "previleges": 2,
    "token": "1*Cwk7m2fznHFi0t02*99235446*4145443734323733424642364342343533393737393543374636333936383238",
    "tokenForHttpServer": "4*MKYl5cDyBcJrKUez*96643746*4139444242343336304535343243323846374130304337424641464139394633",
    "result": true,
    "resultCode" : 0
}

Описание параметров:

type - тип авторизации. В зависимости от типа авторизации параметр принимает значения:
- Защищенная авторизация - значение должно быть равно secured, может быть по паролю, по пину и по токену. В таком случае надо указать соответственно пин, пароль или токен в параметре credentials
- Авторизация без защиты - присутствует, значение должно быть равно unsecured
- Переход в пользователя из-под администратора - отсутствует
role - предназначение. В зависимости от типа авторизации параметр принимает значения:
- Защищенная авторизация, Авторизация без защиты - опциональный параметр. Если присутствует, указывает на результирующий получаемый режим подключения (admin или user) и служит его проверкой. Если параметра нет, тогда режим назначится автоматически и без проверок
- Переход в пользователя из-под администратора - обязательно присутствует и должен быть равен admin
credentials - в зависимости от типа авторизации содержит пароль, пин или токен
resultCode - результат авторизации, принимает следующие числовые значения:
- 0 - успех
- 1 - внутренняя ошибка
- 2 - ошибка авторизации из-за того, что текущий тариф - не Pro
- 3 - ошибка авторизации из-за того, что текущее подключение авторизовано не как администратор
- 4 - ошибка авторизации из-за того, что согласно текущим учетным данным авторизации этот тип безопасности не может быть использован
- 5 - ошибка авторизации из-за того, что после авторизации будут получены привилегии, отличные от требуемых
- 6 - авторизация недоступна из-за частого ввода некорректного пароля. Необходимо подождать прежде чем можно будет снова пытаться авторизоваться
- 7 - ошибка авторизации из-за пустых учетных данных
- 8 - ошибка авторизации из-за некорректных учетных данных
- 9 - ошибка авторизации из-за невалидного значения поля role
- 10 - ошибка авторизации из-за невалидного значения поля type
- 11 - ошибка авторизации из-за того, что отсутствует параметр type
- 12 - ошибка авторизации из-за того, что отсутствует параметр credentials
previleges - результирующий режим управления. Может быть:
- 1 - пользователь
- 2 - администратор
token - токен текущего подключения для использования в API. При обрыве подключения и новом переподключении может быть использован для авторизации по токену. Время жизни токена зависит от используемого типа авторизации:
- Авторизация без защиты - 30 дней или до выключения приложения
- по паролю - 30 дней или до выключения приложения
- по пину - 30 дней или до выключения приложения
- по пину из командной строки - до выключения приложения
- по токену - определяется изначальной авторизацией, в ходе которой он был получен
- Переход в пользователя из-под администратора - определяется изначальной авторизацией, в ходе которой он был получен
tokenForHttpServer - токен текущего подключения для использования на http сервере. Время жизни токена - 5 минут или до выключения приложения
overlayHttpToken - токен для использования на http сервере в функционале наложения. Время жизни токена - до смены авторизационных данных (setAuthParams), до разлогина, до начала или окончания звонка или групповой конференции
requestId - уникальный идентификатор запроса. Детальнее с ним можно ознакомиться здесь

См. также: