GetAuthUserList – Получение списка пользователей в базе eltex_auth

GetAuthUserList – Получение списка пользователей в базе eltex_auth_service

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

Команда актуальна, начиная с версии 1.5
Если count == 0, будет получено количество пользователей size, а список в ответе NBI response будет пустым. При count > 0, наоборот, NBI сформирует список пользователей, и значение size будет равно нулю.

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

Параметр	Значение	Формат значения	Расшифровка формата	Ссылка
domain	Домен роли.	(?=^.{1,235}$)(^((?!-\|_\|.(__\|--).)[a-zA-Z0-9_\-]{1,63}\.)((?!-\|_\|.(__\|--).*)[a-zA-Z0-9_\-]{1,63})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN	Domain
role	Роль пользователя	.*	groupname
count	Кол-во выводимых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
page	Номер страницы, порции выдаваемых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
orderBy	Поле, определяющее, по какому элементу сортировать выдаваемые данные.	.*	username
orderType	Поле определяющее тип сортировки. (По умолчанию ASC)	^(ASC\|DESC)$	ASC или DESC

Параметр

Значение

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

Расшифровка формата

Ссылка

domain

Домен роли.

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

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

Domain

role

Роль пользователя

groupname

count

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

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

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

page

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

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

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

orderBy

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

username

orderType

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

^(ASC|DESC)$

ASC или DESC

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

Параметр	Значение	Формат значения
code	Код ответа	Целое неотрицательное число.
detail	Пояснение к ответу	Текст английскими буквами с пробелами и спецсимволами.
response	Объект NbiAuthUserArray

Параметр

Значение

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

code

Код ответа

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

detail

Пояснение к ответу

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

response

Объект NbiAuthUserArray

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

Код	Описание
0	Успешно

Код

Описание

Успешно

Запрос числа пользователей

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAuthUserList>
         <nbi:domain>root</nbi:domain>
         <nbi:role>default_client_admin</nbi:role>
         <nbi:user/>
         <nbi:count>0</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>username</nbi:orderBy>
         <nbi:orderType>asc</nbi:orderType>
      </nbi:GetAuthUserList>
   </soapenv:Body>
</soapenv:Envelope>

Ответ с числом пользователей

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAuthUserListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax228:NbiAuthUserArrayResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax228:response xsi:type="ax228:NbiAuthUserArray"/>
            <ax228:size>4</ax228:size>
         </ns:return>
      </ns:GetAuthUserListResponse>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetAuthUserList>
         <nbi:domain>root</nbi:domain>
         <nbi:role>default_client_admin</nbi:role>
         <nbi:user/>
         <nbi:count>2</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>username</nbi:orderBy>
         <nbi:orderType>asc</nbi:orderType>
      </nbi:GetAuthUserList>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns:GetAuthUserListResponse xmlns:ns="http://nbi.radius.eltex.org">
         <ns:return xsi:type="ax228:NbiAuthUserArrayResponse">
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax228:response xsi:type="ax228:NbiAuthUserArray">
               <ax228:attr xsi:type="ax228:NbiAuthUser">
                  <ax228:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>1</ax21:value>
                     </ax21:attr>
                  </ax228:check>
                  <ax228:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-01-26 04:55:56</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Name</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Ivan Ivanovich</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Phone</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>79123456789</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Family</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Ivanov</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Timezone</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>Europe/Moscow</ax21:value>
                     </ax21:attr>
                  </ax228:common>
                  <ax228:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Domain</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>root</ax21:value>
                     </ax21:attr>
                  </ax228:reply>
                  <ax228:rolePrioArray xsi:type="ax228:NbiAuthRolePrioArray">
                     <ax228:rolePrio xsi:type="ax228:NbiAuthRolePrio">
                        <ax228:priority>1</ax228:priority>
                        <ax228:role>default_client_admin</ax228:role>
                     </ax228:rolePrio>
                  </ax228:rolePrioArray>
                  <ax228:user>1</ax228:user>
               </ax228:attr>
               <ax228:attr xsi:type="ax228:NbiAuthUser">
                  <ax228:check xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Cleartext-Password</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>2</ax21:value>
                     </ax21:attr>
                  </ax228:check>
                  <ax228:common xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Create-Date</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>2021-01-26 04:56:20</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Name</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Pyotr Petrovich</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Phone</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>79123456789</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Operator-Family</ax21:name>
                        <ax21:oper>:=</ax21:oper>
                        <ax21:value>Petrov</ax21:value>
                     </ax21:attr>
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-User-Timezone</ax21:name>
                        <ax21:oper>=</ax21:oper>
                        <ax21:value>Europe/Moscow</ax21:value>
                     </ax21:attr>
                  </ax228:common>
                  <ax228:reply xsi:type="ax21:NbiAttrArray">
                     <ax21:attr xsi:type="ax21:NbiAttr">
                        <ax21:name>Eltex-Domain</ax21:name>
                        <ax21:oper>+=</ax21:oper>
                        <ax21:value>root</ax21:value>
                     </ax21:attr>
                  </ax228:reply>
                  <ax228:rolePrioArray xsi:type="ax228:NbiAuthRolePrioArray">
                     <ax228:rolePrio xsi:type="ax228:NbiAuthRolePrio">
                        <ax228:priority>1</ax228:priority>
                        <ax228:role>default_client_admin</ax228:role>
                     </ax228:rolePrio>
                  </ax228:rolePrioArray>
                  <ax228:user>2</ax228:user>
               </ax228:attr>
            </ax228:response>
            <ax228:size>0</ax228:size>
         </ns:return>
      </ns:GetAuthUserListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
2	Ошибка доступа к БД
8	Домен не соответствует правилам
62	Домен не зарегистрирован

Вернуться к списку команд
Версия 1.21-2274
Дата публикации 03-12-2021 11:20:22