• Русский
      • Уведомление о переводе ИИ

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

      Синхронизация пользовательских данных через HTTP API

      Получение ключа API

      Обратитесь к разделу Ключи API. Убедитесь, что роль, связанная с ключом API, имеет необходимые разрешения для синхронизации пользовательских данных.

      Обзор API

      Пример

      curl 'https://localhost:13000/api/userData:push' \
  -H 'Authorization: Bearer <token>' \
  --data-raw '{"dataType":"user","records":[]}' # Подробное описание тела запроса см. ниже

      Конечная точка

      POST /api/userData:push

      Формат пользовательских данных

      UserData

      ПараметрТипОписание
      dataType'user' | 'department'Обязательно. Тип передаваемых данных. Для пользовательских данных используйте user.
      matchKey'username' | 'email' | 'phone'Необязательно. Используется для сопоставления с существующими пользователями системы на основе указанного поля.
      recordsUserRecord[]Обязательно. Массив записей пользовательских данных.

      UserRecord

      ПараметрТипОписание
      uidstringОбязательно. Уникальный идентификатор исходных пользовательских данных, используемый для связывания исходных данных с пользователем системы. Неизменяем для одного пользователя.
      nicknamestringНеобязательно. Псевдоним пользователя.
      usernamestringНеобязательно. Имя пользователя.
      emailstringНеобязательно. Адрес электронной почты пользователя.
      phonestringНеобязательно. Номер телефона пользователя.
      departmentsstring[]Необязательно. Массив UID отделов, к которым принадлежит пользователь.
      isDeletedbooleanНеобязательно. Указывает, удалена ли запись.
      <field>anyНеобязательно. Пользовательские поля в таблице пользователей.

      Формат данных отдела

      Info

      Для передачи данных отдела необходимо установить и активировать плагин Отделы.

      DepartmentData

      ПараметрТипОписание
      dataType'user' | 'department'Обязательно. Тип передаваемых данных. Для данных отдела используйте department.
      recordsDepartmentRecord[]Обязательно. Массив записей данных отдела.

      DepartmentRecord

      ПараметрТипОписание
      uidstringОбязательно. Уникальный идентификатор исходных данных отдела, используемый для связывания исходных данных с отделом системы. Неизменяем.
      titlestringОбязательно. Название отдела.
      parentUidstringНеобязательно. UID родительского отдела.
      isDeletedbooleanНеобязательно. Указывает, удалена ли запись.
      <field>anyНеобязательно. Пользовательские поля в таблице отделов.
      Info
      1. Многократная передача данных является идемпотентной операцией.
      2. Если при передаче данных отдела родительский отдел еще не создан, связь не может быть установлена. Вы можете повторно передать данные после создания родительского отдела.
      3. Если при передаче пользовательских данных отдел еще не создан, пользователь не может быть связан с этим отделом. Вы можете повторно передать пользовательские данные после передачи данных отдела.