Перейти к основному содержимому

UserList

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

idstring

Идентификатор списка пользователей

space-idstring

Идентификатор пространства, к которому принадлежит список пользователей

presentationstring

Представление (название) списка пользователей

self-registration object

Самостоятельная регистрация

enabledboolean

Флаг использования самостоятельной регистрации

phone-requiredboolean

Флаг необходимости иметь подтвержденный телефон (если у пользователя не подтвержден телефон, то он не сможет войти в приложение)

email-requiredboolean

Флаг необходимости иметь подтвержденный email (если у пользователя не подтвержден email, то он не сможет войти в приложение)

confirmations object[]

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

  • Array [
  • confirmation-typestring

    Тип способа подтверждения

    enabledboolean

    Флаг использования данного способа подтверждения

  • ]
  • password-policy-enabledboolean

    Флаг использования политики паролей

    password-policy object

    Политика паролей

    min-lengthinteger

    Минимальное количество символов в пароле

    max-lengthinteger

    Максимальное количество символов в пароле

    must-contain-lower-caseboolean

    Флаг необходимости содержания символа в нижнем регистре

    must-contain-upper-caseboolean

    Флаг необходимости содержания символа в верхнем регистре

    must-contain-symbolstring

    Пароль должен содержать хотя бы один символ из приведенной строки (если строка пустая – правило не применяется)

    allowed-alphabetstring

    Пароль должен содержать символы только из приведенной строки (если строка пустая – правило не учитывается

    must-contain-digitboolean

    Пароль должен содержать цифру

    prohibit-previous-passwordsinteger

    Пароль не должен совпадать с определенным количеством последних используемых паролей

    smtp-gateways object[]

    Массив почтовых шлюзов

  • Array [
  • idstring

    Идентификатор шлюза

    userstring

    Пользователь

    passwordstring

    Пароль

    use-sslboolean

    Флаг использования SSL

    allow-start-tlsboolean

    Флаг использования STARTTLS

    serverstring

    Домен сервера

    sender-addressstring

    Адрес отправителя письма

    sender-namestring

    Имя владельца адреса

    portinteger

    Порт

  • ]
  • account-services-settings object[]

    Массив настроек сервисов учетных записей

  • Array [
  • enabledboolean

    Флаг использования сервиса внешних учетных записей

    additional-settings object

    Дополнительные настройки в виде "ключ — значение"

    keystring

    Ключ

    local-idstring

    Локальный идентификатор сервиса внешних учетных записей

    account-service-idstring

    Идентификатор сервиса внешних учетных записей

    account-service-typestring

    Тип сервиса внешних учетных записей (может иметь значения Local, Cas, ActiveDirectory, Esia, OAuth2)

    Possible values: [Local, Cas, ActiveDirectory, Esia, OAuth2]

    create-user-on-authboolean

    Флаг создания нового пользователя в случае, когда была совершена успешная аутентификация

    calculation-rules object

    Правила вычисления свойств пользователя из ответа сервиса учетных записей

    response-kindstring

    Формат ответа сервиса с информацией о пользователе (Json/Xml)

    presentation-rulestring

    Правило вычисления представления пользователя (в формате JsonPath/XPath)

    phone-rulestring

    Правило вычисления телефона пользователя (в формате JsonPath/XPath)

    email-rulestring

    Правило вычисления почты пользователя (в формате JsonPath/XPath)

  • ]
  • sms-gateways object[]

    Массив смс шлюзов

  • Array [
  • urlstring

    url сервиса для отправки СМС

    idstring

    Идентификатор шлюза

    application-idstring

    Идентификатор приложения

  • ]
  • include-personal-data-in-messagesboolean

    Флаг включения персональных данных в смс и email

    UserList
    {
    "id": "string",
    "space-id": "string",
    "presentation": "string",
    "self-registration": {
    "enabled": true,
    "phone-required": true,
    "email-required": true
    },
    "confirmations": [
    {
    "confirmation-type": "string",
    "enabled": true
    }
    ],
    "password-policy-enabled": true,
    "password-policy": {
    "min-length": 0,
    "max-length": 0,
    "must-contain-lower-case": true,
    "must-contain-upper-case": true,
    "must-contain-symbol": "string",
    "allowed-alphabet": "string",
    "must-contain-digit": true,
    "prohibit-previous-passwords": 0
    },
    "smtp-gateways": [
    {
    "id": "string",
    "user": "string",
    "password": "string",
    "use-ssl": true,
    "allow-start-tls": true,
    "server": "string",
    "sender-address": "string",
    "sender-name": "string",
    "port": 0
    }
    ],
    "account-services-settings": [
    {
    "enabled": true,
    "additional-settings": {
    "key": "string"
    },
    "local-id": "string",
    "account-service-id": "string",
    "account-service-type": "Local",
    "create-user-on-auth": true,
    "calculation-rules": {
    "response-kind": "string",
    "presentation-rule": "string",
    "phone-rule": "string",
    "email-rule": "string"
    }
    }
    ],
    "sms-gateways": [
    {
    "url": "string",
    "id": "string",
    "application-id": "string"
    }
    ],
    "include-personal-data-in-messages": true
    }