Account — свойства абонента и управление пользователями абонента

Дата последней модификации страницы: 24.09.2024

Группа методов Account внешнего программного интерфейса Менеджера сервиса предназначена для управления свойствами абонентов и управления пользователями абонентов.

Также к группе методов Account относятся методы для управления обслуживаемыми абонентами (для обслуживающей организации)

Сводка по методам

МетодНазначение
account/attached_infoЗначения дополнительных реквизитов и сведений абонента
account/infoИнформация об абоненте
account/listСписок абонентов
account/update_attached_infoОбновить дополнительные реквизиты и сведения абонента
account/update_infoИзменить свойства абонента
account/servant_tariffs/infoИнформация о тарифе обслуживающей организации
account/servant_tariffs/listСписок тарифов обслуживающей организации
account/servants/listCписок обслуживающих организаций
account/servants/recommended_tariffsСписок рекомендуемых тарифов
account/servants/tariff_selection_pageСтраница выбора тарифа обслуживающей организации
account/users/addПодключить пользователя к абоненту
account/users/available_attached_infoСписок доступных дополнительных реквизитов пользователя абонента.
account/users/createСоздать учетную запись и подключить нового пользователя к абоненту
account/users/deleteОтключить пользователя сервиса от абонента
account/users/infoИнформация о пользователе абонента
account/users/listСписок пользователей абонента
account/users/set_roleУстановить роль пользователя абонента
account/users/set_session_restrictionОграничить количество сеансов пользователя абонента
account/users/update_attached_infoОбновляет дополнительные реквизиты пользователя абонента
account/users/tenant/listСписок приложений, доступных пользователю абонента.

account/attached_info

Значения дополнительных реквизитов и сведений абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
Ответ
public_id *Строка переменная (36)Публичный идентификатор7713754211
propertiesСписок (0..*)Дополнительные сведения
  - keyСтрока переменная (100)Имя свойстваТариф
  - name *Строка переменная (75)Заголовок свойстваТариф
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение свойстваБазовый
  - typeСтрока (перечисление)Тип свойства:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
additional_value
fieldsСписок (0..*)Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаИНН
  - name *Строка переменная (75)Заголовок реквизитаИНН
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизита7799555550
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
string
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/attached_info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "public_id": "7713754211",
  "properties": [
    {
      "key": "Тариф",
      "name": "Тариф",
      "value": "Базовый",
      "type": "additional_value"
    }
  ],
  "fields": [
    {
      "key": "ИНН",
      "name": "ИНН",
      "value": "7799555550",
      "type": "string"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/info

Информация об абоненте

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
Ответ: account (1)
name *Строка переменная (64)Наименование абонентаКонфетпром
idЧисло (+12.0)Код абонента1010
city *Строка переменная (500)ГородМосква
site *Строка переменная (500)Сайтwww.example.com
email *Строка переменная (500)Почтаabramov@example.com
phone *Строка переменная (500)Телефон+7 (495) 123-45-67
site_id *Число (+9.0)Идентификатор сайта123
invitation_id *Строка переменная (9)Номер приглашения для регистрации000000123
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "account": {
    "name": "Конфетпром",
    "id": 1010,
    "city": "Москва",
    "site": "www.example.com",
    "email": "abramov@example.com",
    "phone": "+7 (495) 123-45-67",
    "site_id": 123,
    "invitation_id": "000000123"
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/list

Список абонентов

ПараметрТипОписаниеПример
Запрос
name *Строка переменная (64)Фильтр по наименованию абонентаконф
Ответ: account (0..*)
nameСтрока переменная (64)Наименование абонентаКонфетпром
idЧисло (+12.0)Код абонента1010
roleСтрока (перечисление)Роль пользователя абонента:
  • administrator (Администраторы абонента)
  • ext_administrator (Администраторы средств адаптации)
  • operator (Операторы обслуживающей организации)
  • owner (Владельцы абонента)
  • user (Пользователи абонента)
owner
Пример запроса  Развернуть 
GET или POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/list
Authorization: Basic base64_encode(user:password) или Bearer access_token
Пример ответа  Развернуть 
{
  "account": [
    {
      "name": "Конфетпром",
      "id": 1010,
      "role": "owner"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/update_attached_info

Обновить дополнительные реквизиты и сведения абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
properties *
Дополнительные сведения
  - keyСтрока переменная (100)Имя свойстваТариф
  - name *Строка переменная (75)Заголовок свойстваТариф
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение свойстваБазовый
  - type *Строка (перечисление)Тип свойства:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
additional_value
fields *
Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаИНН
  - name *Строка переменная (75)Заголовок реквизитаИНН
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизита7799555550
  - type *Строка (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
string
Ответ: account (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/update_attached_info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "properties": [
    {
      "key": "Тариф",
      "name": "Тариф",
      "value": "Базовый",
      "type": "additional_value"
    }
  ],
  "fields": [
    {
      "key": "ИНН",
      "name": "ИНН",
      "value": "7799555550",
      "type": "string"
    }
  ],
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/update_info

Изменить свойства абонента

ПараметрТипОписаниеПример
Запрос
nameСтрока переменная (64)Наименование абонентаКонфетпром
idЧисло (+12.0)Код абонента1010
city *Строка переменная (500)ГородМосква
site *Строка переменная (500)Сайтwww.example.com
email *Строка переменная (500)Почтаabramov@example.com
phone *Строка переменная (500)Телефон+7 (495) 123-45-67
site_id *Число (+9.0)Идентификатор сайта123
invitation_id *Строка переменная (9)Номер приглашения для регистрации000000123
Ответ: account (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/update_info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "name": "Конфетпром",
  "id": 1010,
  "city": "Москва",
  "site": "www.example.com",
  "email": "abramov@example.com",
  "phone": "+7 (495) 123-45-67",
  "site_id": 123,
  "invitation_id": "000000123",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/servant_tariffs/info

Информация о тарифе обслуживающей организации

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код обслуживающей организации1000
idСтрока переменная (9)Код тарифа обслуживающей организации000000021
Ответ: servant_tariff (1)
idСтрока переменная (9)Код тарифа обслуживающей организации000000021
nameСтрока переменная (150)Наименование тарифа обслуживающей организацииПример тарифа обслуживающей организации
tariff_idСтрока переменная (9)Код базового тарифа провайдера000000001
brief_description *Строка переменная (1024)Краткое описаниеКраткое описание тарифа
description_for_subscribers *
Информация для абонентов
  - html *Строка неограниченной длиныHTML-код описания для абонентов<html><body><img src="image001?_=1731688253"/><p>Пример описания тарифа</p></body></html>
  - imagesСписок (0..*)Картинки описания
  - images.nameСтрока переменная (255)Имя картинкиimage001
  - images.dataДвоичные данные размером до 1048576 байт в строке Base64Данные картинки, размер до 1 Мб89 50 4E 47 0D 0A 1A 0A 00 00 00 0D 49 48 44 52 00 00 00 10 00 00 00 10 08 06 00 00 00 1F F3 FF 61 0...
validity_periodsСписок (0..*)Периоды действия тарифа
  - idСтрока переменная (10)Код периода1YR
  - nameСтрока переменная (50)Наименование периода1 год
  - quantityЧисло (+10.0)Количество периодов1
  - cost *Число (+10.2)Стоимость1500
  - comment *Строка переменная (1024)КомментарийКомментарий периода действия
  - periodСтрока (перечисление)Тип периода действия:
  • day (День)
  • decade (Декада)
  • half_year (Полугодие)
  • month (Месяц)
  • quarter (Квартал)
  • week (Неделя)
  • year (Год)
year
  - recommended *БулевоРекомендуемыйfalse
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/servant_tariffs/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "id": "000000021",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "servant_tariff": {
    "id": "000000021",
    "name": "Пример тарифа обслуживающей организации",
    "tariff_id": "000000001",
    "brief_description": "Краткое описание тарифа",
    "description_for_subscribers": {
      "html": "Пример описания тарифа",
      "images": [
        {
          "name": "image001",
          "data": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAACHUlEQVQ4jX2Tz2sT\r\ncRDFP9nvtt1N0qQ1m0aINTFSaCEtAa9tMf9DbvZkpXiw4EHw1Is9lYqHehAEPeUi\r\nFPofCJaePKgQocW2uFpLaZrVVJfspt3NeugPNpvowFzem/dmmGFCkTtPCEQKKAFT\r\nwPVzTAfWgVWgBmCWFwCQA+IHok+5N5gbSalaMi4rqgLgWI1Co1a9Xf+6e99t2q+A\r\n5xcCv8Hj/vTwXGIsn5GELPyuPZGoGo9E1di1zFBts/Lwz/5eGFgCkM5r5vvTw3PJ\r\nfCHnF0+mY0ymY5dGISFEMl/I9aeH56Izi/MXBproU2a10fEMHvjz6XSW5aksQVwb\r\nHc/IfcpsdGYxJQOlgRs3hxBCeIGFPHqnw7muLYQQ8dxIytislGRgWk0kB7qU4V1i\r\nnZya0OLAlAxkZSWsdKlhpZjD8+BW+VMHJythBcgEz9gWPVLo32Sr5QGnEqA7VsMO\r\nLqptoi6cY9tNYF8C1q3aUf1/k3QLyzg6BjYkYLX+bbfachzX8zz8+eHQ5GPVJIi3\r\nHMet6zuHwKronSg2PNfpcZv2WDh5ddDfZW3bYG3b6OhubFX0Zv3nC7O88Fb0ThQB\r\n3p+Yv1XHtnPqFS0WkiSpQwV4rusaWxXdPPjx0iwvPIP2X1gyD/Ysy6jeHciOpJSE\r\nFj87b8tzLMu2ftWOj/WdqnvSfA2sXIiCZ1xxT5pvjC+fS8A0kAFOge/ABmfvfOQX\r\n/AXZ2ePwCmgSWAAAAABJRU5ErkJggg=="
        }
      ]
    },
    "validity_periods": [
      {
        "id": "1YR",
        "name": "1 год",
        "quantity": 1,
        "cost": 1500,
        "comment": "Комментарий периода действия",
        "period": "year",
        "recommended": false
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/servant_tariffs/list

Список тарифов обслуживающей организации

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код обслуживающей организации1000
scope *Массив из Строка (перечисление)Параметры получения данных:
  • is_extension (Только тарифы с типом "Расширение")
  • validity_periods (Включать периоды действия)
["validity_periods"]
available_tariffs *Массив из Строка переменная (9)Отбор доступных тарифов расширений["000000002","000000003"]
Ответ: servant_tariff (0..*)
idСтрока переменная (9)Код тарифа обслуживающей организации000000021
nameСтрока переменная (150)Наименование тарифа обслуживающей организацииПример тарифа обслуживающей организации
tariff_idСтрока переменная (9)Код базового тарифа провайдера000000001
brief_description *Строка переменная (1024)Краткое описаниеКраткое описание тарифа
validity_periodsСписок (0..*)Периоды действия тарифа
  - idСтрока переменная (10)Код периода1YR
  - nameСтрока переменная (50)Наименование периода1 год
  - quantityЧисло (+10.0)Количество периодов1
  - cost *Число (+10.2)Стоимость1500
  - comment *Строка переменная (1024)КомментарийКомментарий периода действия
  - periodСтрока (перечисление)Тип периода действия:
  • day (День)
  • decade (Декада)
  • half_year (Полугодие)
  • month (Месяц)
  • quarter (Квартал)
  • week (Неделя)
  • year (Год)
year
  - recommended *БулевоРекомендуемыйfalse
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/servant_tariffs/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "servant_tariff": [
    {
      "id": "000000021",
      "name": "Пример тарифа обслуживающей организации",
      "tariff_id": "000000001",
      "brief_description": "Краткое описание тарифа",
      "validity_periods": [
        {
          "id": "1YR",
          "name": "1 год",
          "quantity": 1,
          "cost": 1500,
          "comment": "Комментарий периода действия",
          "period": "year",
          "recommended": false
        }
      ]
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/servants/list

Cписок обслуживающих организаций

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
Ответ: servants (0..*)
name *Строка переменная (64)Наименование абонентаПомощник 1С
idЧисло (+12.0)Код абонента1000
servant_id *Строка переменная (50)Идентификатор00000
city *Строка переменная (500)ГородМосква
site *Строка переменная (500)Сайтwww.example.com
email *Строка переменная (500)Почтаinfo@example.com
phone *Строка переменная (500)Телефон+7 (495) 765-43-21
site_id *Число (+9.0)Идентификатор сайта123
invitation_id *Строка переменная (9)Номер приглашения для регистрации000000123
tariff_subscribe_allowed *БулевоРазрешено подписывать на тарифыtrue
automatic_billing_allowed *БулевоРазрешено автоматическое выставление счетовfalse
tariff_override_allowed *БулевоРазрешено переопределение тарифов провайдераfalse
tariff_selection_page_only *БулевоОтображать только собственную страницу выбора тарифовfalse
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/servants/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "servants": [
    {
      "name": "Помощник 1С",
      "id": 1000,
      "servant_id": "00000",
      "city": "Москва",
      "site": "www.example.com",
      "email": "info@example.com",
      "phone": "+7 (495) 765-43-21",
      "site_id": 123,
      "invitation_id": "000000123",
      "tariff_subscribe_allowed": true,
      "automatic_billing_allowed": false,
      "tariff_override_allowed": false,
      "tariff_selection_page_only": false
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/servants/recommended_tariffs

Список рекомендуемых тарифов

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код обслуживающей организации1000
Ответ: recommended_tariffs (0..*)
provider_tariff_idСтрока переменная (9)Код тарифа провайдера000000001
servant_tariff_id *Строка переменная (9)Код тарифа обслуживающей организации000000001
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/servants/recommended_tariffs
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "recommended_tariffs": [
    {
      "provider_tariff_id": "000000001",
      "servant_tariff_id": "000000001"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/servants/tariff_selection_page

Страница выбора тарифа обслуживающей организации

ПараметрТипОписаниеПример
Запрос
servantЧисло (+12.0)Код обслуживающей организации1000
Ответ: html (1)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/servants/tariff_selection_page
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "servant": 1000,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "html": "Пример страницы выбора тарифа",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/add

Подключить пользователя к абоненту

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Администраторы абонента)
  • ext_administrator (Администраторы средств адаптации)
  • operator (Операторы обслуживающей организации)
  • owner (Владельцы абонента)
  • user (Пользователи абонента)
owner
loginСтрока переменная (50)Логин пользователяLarionova
description *Строка переменная (300)Описание пользователя абонентаОписание текущего пользователя абонента
force *БулевоВыполнить даже при наличии предупрежденийfalse
fields *
Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаВнешнийПользователь
  - name *Строка переменная (75)Заголовок реквизитаВнешнийПользователь
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизитаtrue
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
boolean
tenants *
Права на приложения.
  - idЧисло (+7.0)Номер приложения2000
  - role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
Ответ: sites (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/add
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "role": "owner",
  "login": "Larionova",
  "description": "Описание текущего пользователя абонента",
  "force": false,
  "fields": [
    {
      "key": "ВнешнийПользователь",
      "name": "ВнешнийПользователь",
      "value": true,
      "type": "boolean"
    }
  ],
  "tenants": [
    {
      "id": 2000,
      "role": "administrator"
    }
  ],
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/available_attached_info

Список доступных дополнительных реквизитов пользователя абонента.

ПараметрТипОписаниеПример
Запрос
Ответ: fields (0..*)
keyСтрока переменная (100)Имя реквизитаВнешнийПользователь
name *Строка переменная (75)Заголовок реквизитаВнешний пользователь
typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
boolean
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/available_attached_info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "fields": [
    {
      "key": "ВнешнийПользователь",
      "name": "Внешний пользователь",
      "type": "boolean"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/create

Создать учетную запись и подключить нового пользователя к абоненту

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Администраторы абонента)
  • ext_administrator (Администраторы средств адаптации)
  • operator (Операторы обслуживающей организации)
  • owner (Владельцы абонента)
  • user (Пользователи абонента)
owner
loginСтрока переменная (50)Логин пользователяNestor
password *Строка неограниченной длиныПароль пользователяw13p-3q
email *Строка переменная (254)Адрес электронной почтыnestor@example.com
email_required *БулевоУказан адрес электронной почтыfalse
nameСтрока переменная (150)Полное имя пользователяИващенко Нестор Иванович
phone *Строка переменная (500)Телефон пользователя+7 (495) 231-54-76
timezone *Строка переменная (100)Часовой пояс пользователяEurope/Moscow
description *Строка переменная (300)Описание пользователя абонентаОписание пользователя абонента
invite *БулевоПригласить пользователя. Если Истина, то не активируется приглашение для регистрации.false
fields *
Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаВнешнийПользователь
  - name *Строка переменная (75)Заголовок реквизитаВнешнийПользователь
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизитаtrue
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
boolean
tenants *
Права на приложения.
  - idЧисло (+7.0)Номер приложения2000
  - role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
Ответ: fields (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "role": "owner",
  "login": "Nestor",
  "password": "w13p-3q",
  "email": "nestor@example.com",
  "email_required": false,
  "name": "Иващенко Нестор Иванович",
  "phone": "+7 (495) 231-54-76",
  "timezone": "Europe/Moscow",
  "description": "Описание пользователя абонента",
  "invite": false,
  "fields": [
    {
      "key": "ВнешнийПользователь",
      "name": "ВнешнийПользователь",
      "value": true,
      "type": "boolean"
    }
  ],
  "tenants": [
    {
      "id": 2000,
      "role": "administrator"
    }
  ],
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/delete

Отключить пользователя сервиса от абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
loginСтрока переменная (50)Логин пользователяAbramov
Ответ: fields (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/delete
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "login": "Abramov",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/info

Информация о пользователе абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
loginСтрока переменная (50)Логин пользователяAbramov
Ответ: user (1)
loginСтрока переменная (50)Логин пользователяAbramov
is_temporaryБулевоВременный доступfalse
session_restriction *Число (+10.0)Разрешенное количество сеансов5
description *Строка переменная (300)Описание пользователя абонентаОписание текущего пользователя абонента
email *Строка переменная (254)Адрес электронной почтыabramov@example.com
phone *Строка переменная (500)Телефон пользователя+7 (495) 123-45-67
nameСтрока переменная (150)Полное имя пользователяАбрамов Геннадий Сергеевич
role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Администраторы абонента)
  • ext_administrator (Администраторы средств адаптации)
  • operator (Операторы обслуживающей организации)
  • owner (Владельцы абонента)
  • user (Пользователи абонента)
owner
fieldsСписок (0..*)Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаВнешнийПользователь
  - name *Строка переменная (75)Заголовок реквизитаВнешнийПользователь
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизитаtrue
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
boolean
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "login": "Abramov",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "user": {
    "login": "Abramov",
    "is_temporary": false,
    "session_restriction": 5,
    "description": "Описание текущего пользователя абонента",
    "email": "abramov@example.com",
    "phone": "+7 (495) 123-45-67",
    "name": "Абрамов Геннадий Сергеевич",
    "role": "owner",
    "fields": [
      {
        "key": "ВнешнийПользователь",
        "name": "ВнешнийПользователь",
        "value": true,
        "type": "boolean"
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/list

Список пользователей абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
name *Строка переменная (150)Фильтр по имени пользователяГеннадий
Ответ: user (0..*)
loginСтрока переменная (50)Логин пользователяAbramov
is_temporaryБулевоВременный доступfalse
session_restriction *Число (+10.0)Разрешенное количество сеансов5
email *Строка переменная (254)Адрес электронной почтыabramov@example.com
nameСтрока переменная (150)Полное имя пользователяАбрамов Геннадий Сергеевич
description *Строка переменная (300)Описание пользователя абонентаОписание текущего пользователя абонента
role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Администраторы абонента)
  • ext_administrator (Администраторы средств адаптации)
  • operator (Операторы обслуживающей организации)
  • owner (Владельцы абонента)
  • user (Пользователи абонента)
owner
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "user": [
    {
      "login": "Abramov",
      "is_temporary": false,
      "session_restriction": 5,
      "email": "abramov@example.com",
      "name": "Абрамов Геннадий Сергеевич",
      "description": "Описание текущего пользователя абонента",
      "role": "owner"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/set_role

Установить роль пользователя абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
loginСтрока переменная (50)Логин пользователяAbramov
roleСтрока (перечисление)Роль пользователя абонента:
  • administrator
  • ext_administrator
  • operator
  • owner
  • user
owner
Ответ: user (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/set_role
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "login": "Abramov",
  "role": "owner",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/set_session_restriction

Ограничить количество сеансов пользователя абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
loginСтрока переменная (50)Логин пользователяAbramov
restrictionЧисло (+10.0)Разрешенное количество сеансов5
Ответ: user (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/set_session_restriction
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "login": "Abramov",
  "restriction": 5,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/update_attached_info

Обновляет дополнительные реквизиты пользователя абонента

ПараметрТипОписаниеПример
Запрос
idЧисло (+12.0)Код абонента1010
loginСтрока переменная (50)Логин пользователяAbramov
fields *
Дополнительные реквизиты
  - keyСтрока переменная (100)Имя реквизитаВнешнийПользователь
  - name *Строка переменная (75)Заголовок реквизитаВнешнийПользователь
  - value *Число (любое), Строка неограниченной длины, Дата и время в строке формата ISO, БулевоЗначение реквизитаtrue
  - typeСтрока (перечисление)Тип реквизита:
  • additional_value (Дополнительное значение)
  • additional_value_group (Дополнительное значение (иерархия))
  • boolean (Булево)
  • date (Дата)
  • decimal (Число)
  • service (Услуга)
  • service_provider_tariff (Тариф поставщика услуг)
  • string (Строка)
  • subscriber (Абонент)
  • subscription (Подписка)
  • tariff (Тариф)
  • tariff_period (Период действия)
  • user (Пользователь)
boolean
Ответ: user (0..*)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/update_attached_info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1010,
  "login": "Abramov",
  "fields": [
    {
      "key": "ВнешнийПользователь",
      "name": "ВнешнийПользователь",
      "value": true,
      "type": "boolean"
    }
  ],
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

account/users/tenant/list

Список приложений, доступных пользователю абонента.

ПараметрТипОписаниеПример
Запрос
loginСтрока переменная (50)Логин пользователяAbramov
Ответ: tenants (0..*)
idЧисло (+7.0)Номер приложения2000
role *Строка (перечисление)Роль пользователя абонента:
  • administrator (Запуск и администрирование)
  • api (Доступ к API)
  • user (Запуск)
administrator
setup_required *БулевоТребуется настройка прав в приложенииfalse
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/account/users/tenant/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "login": "Abramov",
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "tenants": [
    {
      "id": 2000,
      "role": "administrator",
      "setup_required": false
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 29,
    "sm_version": "1.1.38.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх