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

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

GET /console/api/v2/spaces/{SpaceId}/user-lists

Параметры пути

SpaceId: Идентификатор пространства

Тело запроса

Не используется

Тело ответа

Массив объектов типа UserList. Списки пользователей

[
    {
        "id": "string",
        "space-id": "string",
        "presentation": "string",
        "self-registration": {
          "email-required": true,
          "enabled": true,
          "phone-required": 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",
            "use-ssl": true,
            "allow-start-tls": true,
            "server": "string",
            "password": "string",
            "sender-address": "string",
            "sender-name": "string",
            "port": 0
          }
        ],
        "account-services-settings": [
          {
            "enabled": true,
            "additional-settings": {
              "cas-domain-name": "string",
              "cas-server-url": "string"
            },
            "local-id": "string",
            "account-service-id": null,
            "account-service-type": "string",
            "create-user-on-auth": true
          }
        ],
        "sms-gateways": [
          {
            "url": "string",
            "id": "string",
            "application-id": "string"
          }
        ],
        "include-personal-data-in-messages": true
    }
]

id

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

space-id

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

presentation

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

self-registration

Настройки самостоятельной регистрации

email-required: Булево
enabled: Булево
phone-required: Булево

password-policy-enabled

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

password-policy

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

min-length: Число
max-length: Число
must-contain-lower-case: Булево
must-contain-upper-case: Булево
must-contain-symbol: Строка
allowed-alphabet: Строка
must-contain-digit: Булево
prohibit-previous-passwords: Число

smtp-gateways

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

id: Строка
user: Строка
use-ssl: Булево
allow-start-tls: Булево
server: Строка
password: Строка
sender-address: Строка
sender-name: Строка
port: Число

account-services-settings

Массив настроек сервисов аккаунтов

enabled: Булево
additional-settings: Дополнительные настройки в виде "ключ — значение"
local-id: Строка
account-service-id: Null
account-service-type: Строка
create-user-on-auth: Булево

sms-gateways

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

url: Строка
id: Строка
application-id: Строка. Идентификатор приложения

include-personal-data-in-messages

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

Коды состояния

200: Перечень списков пользователей в рамках пространства успешно получен (Array<UserList>)
401: Строка. Отсутствие аутентификации (ErrorData с кодом 16)
403: Строка. Отсутствие авторизации (ErrorData с кодом 7)
404: Строка. Неизвестный идентификатор (ErrorData с кодом 5)
500: Строка. Ошибка на стороне сервера (ErrorData с кодом 13)

ErrorData. Данные ошибки

{
  "code": 3,
  "status": "INVALID_ARGUMENT",
  "message": "1111 is not a valid UUID.",
  "details": "details"
}

code: Число. Код ошибки
status: Строка. Статус ошибки
message: Строка. Сообщение ошибки
details: Строка. Детали ошибки