Створення / редагування користувача

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

Вибір дії (створення або редагування). В разі якщо в тілі запиту (json) присутній userId, то користувач з зазначеним Id підлягає редагуванню. Відсутність параметра userId веде до створення нового користувача.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edin.ua/bdoc/user

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

fio, email (повинен бути валідний з доменною частиною), passPolicyId

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST / RESPONSE

Опис json-параметрів запиту та відповіді метода API (об’єкт User)

Таблиця 1 - Опис параметрів об’єкта User

Параметр

Формат

Опис

Об’єкт User

userId

long

ID користувача

accountId

long

ID аккаунта

email

String

email та логін користувача

password

String

пароль користувача

isOwner

int

ознака власника аккаунта; 0 - ні, 1 - так

isCaptcha

Integer

ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)

fio

String

ПІБ користувача

tel

String

телефон

companies

List<Company_>

масив об’єктів; компанії

account

Account_

об’єкт; дані облікового запису

status

int

статус користувача («1» - активний; «2» - заблокований)

roles

List<Role_>

масив об’єктів; ролі

routes

List<PackageRoute_>

масив об’єктів; маршрути

passSecureType

int

рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)

passPolicyId

long

id пральний політики, застосованої до користувача

userInfo

UserInfo

об’єкт; інформація про користувача

lastLoginIp

String

IP-адреса останнього входу

lastLoginDate

long

дата останнього входу

uiTypes

List<UIType2Role_>

масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

Таблиця 2 - Опис параметрів об’єкта UserInfo

Параметр

Формат

Опис

Об’єкт UserInfo

position

String

посада

department

String

відділ

comment

String

коментар

whiteList

List<String>

масив; список «білих» IP адрес

decryptType

int

тип розшифровки; «1 - WEB; 2 - Cryptex»

cryptexServer

String

адреса cryptex-сервера на стороні клієнта

language

int

мова, «1 - російська; 2 - англійська; 3 - українська»

notShowWizard

tinyint

відмітка «Не показувати майстер налаштувань при повторному вході», 0 - показувати(нема відмітки), 1- Не показувати(є відмітка)


Приклади

Приклад тіла запиту (json):

{
  "isOwner": 0,
  "user_id": 467,
  "status": 1,
  "userInfo": {
    "whiteList": [],
    "decryptType": 1,
    "language": 1,
    "department": null,
    "position": null,
    "comment": null
  },
  "fio": "fdsfs",
  "email": "dfsfsdf@meta.ua",
  "tel": null,
  "passPolicyId": 282
}

Приклад тіла відповіді (json):

{
  "userId": 469,
  "accountId": 8,
  "email": "dfsffdsfsdsdf@meta.ua",
  "isOwner": 0,
  "isCaptcha": 1,
  "fio": "fdsffdss",
  "companies": [],
  "status": 1,
  "roles": [],
  "routes": [],
  "passSecureType": 2,
  "passPolicyId": 282,
  "userInfo": {
    "whiteList": [],
    "decryptType": 1,
    "language": 1
  },
  "lastLoginIp": "0.0.0.0",
  "lastLoginDate": 0,
  "uiTypes": [],
  "userAccess": {}
}