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

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

POST 
/console/api/v2/user-lists

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

Request​

Body

В теле запроса space-id может иметь значение null. В этом случае список пользователей будет создан в пространстве, используемом по умолчанию

    presentation string

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

    space-id string

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

    include-personal-data-in-messages boolean

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

    self-registration

    object

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

    enabled boolean

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

    phone-required boolean

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

    email-required boolean

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

Responses​

Список пользователей успешно создан

Schema

    id string

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

    space-id string

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

    presentation string

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

    self-registration

    object

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

    enabled boolean

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

    phone-required boolean

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

    email-required boolean

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

    password-policy-enabled boolean

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

    password-policy

    object

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

    min-length integer

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

    max-length integer

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

    must-contain-lower-case boolean

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

    must-contain-upper-case boolean

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

    must-contain-symbol string

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

    allowed-alphabet string

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

    must-contain-digit boolean

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

    prohibit-previous-passwords integer

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

    smtp-gateways

    object[]

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

  • Array [

    • id string

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

    user string

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

    password string

    Пароль

    use-ssl boolean

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

    allow-start-tls boolean

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

    server string

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

    sender-address string

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

    sender-name string

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

    port integer

    Порт

  • ]

    • account-services-settings

    object[]

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

  • Array [

    • enabled boolean

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

    additional-settings

    object

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

    key string

    Ключ

    local-id string

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

    account-service-id string

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

    account-service-type string

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

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

    create-user-on-auth boolean

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

  • ]

    • sms-gateways

    object[]

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

  • Array [

    • url string

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

    id string

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

    application-id string

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

  • ]

    • include-personal-data-in-messages boolean

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

Loading...