Труконф

# setAuthParams

Описание: установить новый тип защиты для управления VideoSDK/Room пользователем или администратором.

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

Для того, чтобы задать защищенный режим пользователю, перед этим необходимо задать защищенный режим администратору.

Пример запроса (Установка "Авторизация по паролю"):

{
    "method" : "setAuthParams",
    "requestId" : "1",
    "userType" : "admin",
    "authType" : "password",
    "password" : "123456"
}

Пример запроса (Установка авторизации "по PIN"):

{
    "method" : "setAuthParams",
    "requestId" : "1",
    "userType" : "admin",
    "authType" : "pin"
}

Пример запроса (Тип авторизации "Без защиты"):

{
    "method" : "setAuthParams",
    "requestId" : "1",
    "userType" : "admin",
    "authType" : "unsecured"
}

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

{
    "result" : true,
    "newPin" : "ABC123",
    "method" : "setAuthParams",
    "requestId" : "1"
}

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

  • authType - тип устанавливаемой защиты. Может быть:

    • password - по паролю

    • pin - по пину. В ответе будет получен новый пин.

    • unsecured - без защиты

  • userType - тип учетки, для которой устанавливается защита. Может быть admin или user (при доступности)

  • password - пароль, поле должно присутствовать при установке защиты по паролю

  • token - токен текущего подключения для использования в API. При обрыве подключения и новом переподключении может быть использован для авторизации по токену. Присутствует, если был изменен тип защиты для пользователя, под которым выполняется текущее подключение. Время жизни токена зависит от используемого типа авторизации:

    • "authType" : "unsecured" (без защиты) - 30 дней или до выключения приложения

    • "authType" : "password" (по паролю) - 30 дней или до выключения приложения

    • "authType" : "pin" (по пину) - 24 часа или до выключения приложения

    • по токену - определяется изначальной авторизацией, в ходе которого и был получен этот токен

  • tokenForHttpServer - токен текущего подключения для использования на http сервере. Время жизни токена - 5 минут или до выключения приложения

  • newPin - новый пин. Поле присутствует, если был задан тип защиты по пину: "authType" : "pin"

  • requestId - уникальный идентификатор запроса. Детальнее с ним можно ознакомиться здесь

См. также: