/Methods/GetLoginData

<< Click to Display Table of Contents >>

Navigation:  API MasterSCADA 4D > Подключение к исполнительной системе по JSON > HTTP API MasterPLC > Общие методы >

/Methods/GetLoginData

Возвращает данные для окна логина: состояние сервера, параметры аутентификации, список операторов и ролей, а при действующей сессии — сведения о ней.

HTTP: POST /Methods/GetLoginData

Запрос

{ "sessionId": 1234 }

Поля запроса

Поле

Тип

Обязательное

По умолчанию

Описание

sessionId

integer

нет

0

Идентификатор сессии; при действующей сессии добавляется блок session

Ответ

{
  "projectId": "b1f0…",
  "projectVersion": 12,
  "projectSessionId": 3,
  "isMaster": true,
  "status": 20,
  "features": 0,
  "sessionId": 319824816,
  "session": {
    "serverTime": 1745410360467,
    "startMnemoscheme": "18095",
    "groups": ["Роль 1"],
    "shifts": [],
    "sessionId": 319824816,
    "user": "sa",
    "fullName": "",
    "clientAddress": "127.0.0.1",
    "hostName": "",
    "sessionExpireTime": 0,
    "sessionIdleTime": 0,
    "currentShift": { "ShiftName": "", "WorkDays": 0, "StartTime": 0, "EndTime": 0 }
  },
  "requestPasswordOnLogout": false,
  "startMnemoscheme": "18095",
  "needLogin": true,
  "disableSelectUser": false,
  "disableHashPassword": true,
  "operators": [
    { "login": "sa", "groups": ["Роль 1"] }
  ],
  "roles": [],
  "code": 0
}

Поля ответа

Поле

Тип

Условие

Описание

поля состояния сервера

всегда

См. общий контракт

sessionId

integer

передан действующий sessionId

Идентификатор сессии

session

object

передан действующий sessionId

serverTime + данные оператора (startMnemoscheme, groups, shifts, при наличии — rights) + блок сессии

requestPasswordOnLogout

bool

всегда

Требовать пароль при выходе

startMnemoscheme

string

всегда

Стартовое окно по умолчанию

defaultUser

string

задан пользователь по умолчанию

Пользователь для автоматического входа

needLogin

bool

всегда

Нужно ли показывать окно логина

disableSelectUser

bool

всегда

Ввод логина без выпадающего списка (тогда operators пуст)

disableHashPassword

bool

всегда

Не хешировать пароль на клиенте (всегда true)

operators

array

всегда

Операторы { login, groups }; непусто только если AD отключён и disableSelectUser = false

roles

array

всегда

Роли проекта с их настройками

code

integer

всегда

Состояние проекта

Поведение и ограничения

Список ролей возвращается в поле roles (в старой справке — groups); операторы содержат только login и groups. Сведения о текущей сессии — в блоке session, отдельного поля currentOperator этот метод не возвращает.

При OpcUa_BadServiceUnsupported (визуализация недоступна) текст ошибки — в errorText.