RetrieveRadiusUserList – Запрос списка аккаунтов WiFi клиентов из базы RADIUS

Общая информация

  1. Команда актуальна, начиная с версии 1.5

  2. Не отдает информацию по дочерним доменам

Входные параметры

Параметр Значение Формат значения Расшифровка формата Ссылка

usernаme

Логин клиента, если установлен, то выдается список аккаунтов, логин которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

Текст до 64-х символов.

Wi-Fi пользователь

domain

Домен клиента, может быть пустым.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]\{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN.

Domain

tariffCode

Фильтр по коду тарифного плана. Может отсутствовать.

^.{1,64}$

Текст до 64-х символов.

deactivated

Фильтр активности пользователей. Если отсутствует - означает, что фильтр не задан, 'true' - получить только деактивированных пользователей, 'false' - только активных пользователей.

^(true|false|)$

true, false или пустое значение.

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

page

Номер страницы, порции выдаваемых элементов, обязательно.

^[1-9][0-9]*$

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

.*

username, domain, tariffCode или имя любого атрибута (при условии, что атрибут будет указан в списке attributeName)

orderType

Поле определяющее тип сортировки. (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

attributeName

0 или более строковых элементов, определяющий имена атрибутов, которые нужно вернуть. Если не задано ни одного, то возвращаются все атрибуты, но тогда нельзя использовать сортировку по атрибуту.

.*

Атрибуты пользователя, ожидается один или больше объект NbiAttr.

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число.

detail

Пояснение к ответу. При успешном выполнении команды содержит суммарное количество пользователей, которые удовлетворяют условиям выборки.

Текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiRadiusUserItemSingle.

Примеры команд и кодов

Код Описание ошибки

0

Успешно
Запрос
      <nbi:RetrieveRadiusUserList>
         <nbi:username></nbi:username>
         <nbi:domain></nbi:domain>
         <nbi:tariffCode></nbi:tariffCode>
         <nbi:deactivated></nbi:deactivated>
         <nbi:count>2</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy></nbi:orderBy>
         <nbi:orderType>asc</nbi:orderType>
         <nbi:attributeName>TLS-Client-Cert-Serial</nbi:attributeName>
      </nbi:RetrieveRadiusUserList>
Ответ
      <ns:RetrieveRadiusUserListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>174</ax21:detail>
            <ax21:response xsi:type="ax21:NbiRadiusUserItemArray">
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/0025693512.zip</ax21:clientCrtLink>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>0025693512</ax21:name>
                  <ax21:password>1149413</ax21:password>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>1149413</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>5c</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
               <ax21:item xsi:type="ax21:NbiRadiusUserItemSingle">
                  <ax21:clientCrtLink>http://127.0.0.1:8080/eltex-radius-nbi/certificates/root/0039471949.zip</ax21:clientCrtLink>
                  <ax21:domain>root</ax21:domain>
                  <ax21:name>0039471949</ax21:name>
                  <ax21:password>4705443</ax21:password>
                  <ax21:tariffCode/>
                  <ax21:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>4705443</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>TLS-Client-Cert-Serial</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>3e</ax21:value>
                     </ax21:attr>
                  </ax21:check>
                  <ax21:common xsi:type="ax21:NbiAttrArray"/>
                  <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                  <ax21:verificationWay xsi:nil="true"/>
               </ax21:item>
            </ax21:response>
         </ns:return>
      </ns:RetrieveRadiusUserListResponse>
Код Описание ошибки

8

Домен не соответствует правилам FQDN

10

Домен роли не имеет прав на домен пользователя или домен тарифного плана

100

Тарифного плана с таким кодом не существует

112

Не установлен параметр в поле count

113

Не установлен параметр в поле page

114

Некорректное значение поля orderBy

См. также

Вернуться к списку команд
Версия 1.22-2494
Дата публикации 05-04-2022 04:47:30