ListUsers (v2)

Overview

Lists users.

The function is available as a Web Service request.

Request

Parameters of the API request:

Parameter	Type	Description	Requirements
token	String	API authentication token	Mandatory
filter	UserFilter	Filter parameters	Mandatory

Response

Parameters of the API response in listUsers type called return:

Parameter

Type

Description

status

Status

Possible return values:

- OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
- ERROR_NOT_FOUND
- ERROR_TOO_MANY_RESULT

userCount

Integer

Number of returned Users (returned only if justCount in the filter parameter is true)

users

User

User list (returned only if justCount in the filter parameter is false)

Examples

Example ListUsers transaction, skipping extension, group and role information.

Example ListUsers transaction, skipping extension, group and role information.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v2:listUsers>
         <token>YWygO3Nw0LlqWWThMKxBa18G3zQ8HKq3</token>
         <filter>
            <environmentFilter>
               <eid>0000</eid>
               <eidExact>0</eidExact>
               <inactive>0</inactive>
               <!--
               <shortName></shortName>
               <shortNameExact></shortNameExact>
               -->
            </environmentFilter>
            <!--  <extension></extension> -->
            <extensionExact>0</extensionExact>
            <!-- <externalId></externalId> -->
            <externalIdExact>0</externalIdExact>
            <!-- <group></group> -->
            <groupExact>0</groupExact>
            <inactive>0</inactive>
            <justCount>0</justCount>
            <!-- <loginName></loginName> -->
            <loginNameExact>0</loginNameExact>
            <!-- <role></role> -->
            <roleExact>0</roleExact>

            <!-- skip extensions, group memberships, roles --> 
            <skipExtensions>1</skipExtensions>
            <skipGroups>1</skipGroups>
            <skipRoles>1</skipRoles>
         </filter>
      </v2:listUsers>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listUsersResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <users>
               <apiAccessOnly>false</apiAccessOnly>
               <displayName>Verba Administrator</displayName>
               <eid>0000</eid>
               <email/>
               <environmentShortName>Ref.</environmentShortName>
               <id>1</id>
               <language>en</language>
               <locked>false</locked>
               <loginName>Administrator</loginName>
               <needChangePassword>false</needChangePassword>
               <nonModifiable>false</nonModifiable>
               <passwordExpires>false</passwordExpires>
               <timeZone>Europe/Budapest</timeZone>
               <userType>user_type_verba</userType>
               <validFrom>2014-08-28T07:42:37.193Z</validFrom>
               <validTo>2099-12-31T00:00:00Z</validTo>
            </users>
            <users>
               <apiAccessOnly>false</apiAccessOnly>
               <displayName>Aron Diofasi</displayName>
               <eid>0000</eid>
               <environmentShortName>Ref.</environmentShortName>
               <id>12</id>
               <language>en</language>
               <locked>false</locked>
               <loginName>aron</loginName>
               <needChangePassword>false</needChangePassword>
               <nonModifiable>false</nonModifiable>
               <passwordExpires>false</passwordExpires>
               <timeZone>Europe/Budapest</timeZone>
               <userType>user_type_verba</userType>
               <validFrom>2015-11-19T14:35:26.310Z</validFrom>
               <validTo>2099-12-31T00:00:00Z</validTo>
            </users>
            <users>
               <apiAccessOnly>false</apiAccessOnly>
               <displayName>Bajzat Tamas</displayName>
               <eid>0000</eid>
               <environmentShortName>Ref.</environmentShortName>
               <id>13</id>
               <language>en</language>
               <locked>false</locked>
               <loginName>bajzat</loginName>
               <needChangePassword>false</needChangePassword>
               <nonModifiable>false</nonModifiable>
               <passwordExpires>false</passwordExpires>
               <timeZone>Europe/Budapest</timeZone>
               <userType>user_type_verba</userType>
               <validFrom>2015-11-19T14:35:26.310Z</validFrom>
               <validTo>2099-12-31T00:00:00Z</validTo>
            </users>
         </return>
      </ns2:listUsersResponse>
   </S:Body>
</S:Envelope>

Example ListUsers transaction. Filtering for a group. Skipping group information.

Example ListUsers transaction. Filtering for a group. Skipping group information.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v2:listUsers>
         <token>YWygO3Nw0LlqWWThMKxBa18G3zQ8HKq3</token>
         <filter>
            <environmentFilter>
               <eid>0000</eid>
               <eidExact>0</eidExact>
               <inactive>0</inactive>
               <!--
               <shortName></shortName>
               <shortNameExact></shortNameExact>
               -->
            </environmentFilter>
            <!--  <extension></extension> -->
            <extensionExact>0</extensionExact>
            <!-- <externalId></externalId> -->
            <externalIdExact>0</externalIdExact>
            <group>Nest group2</group>
            <groupExact>0</groupExact>
            <inactive>0</inactive>
            <justCount>0</justCount>
            <!-- <loginName></loginName> -->
            <loginNameExact>0</loginNameExact>
            <!-- <role></role> -->
            <roleExact>0</roleExact>
            <skipExtensions>0</skipExtensions>
            <skipGroups>1</skipGroups>
            <skipRoles>0</skipRoles>
         </filter>
      </v2:listUsers>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listUsersResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <users>
               <agentId/>
               <apiAccessOnly>false</apiAccessOnly>
               <crmUserId/>
               <customDateFormat/>
               <customTimeFormat/>
               <displayName>IPTUser2</displayName>
               <eid>0000</eid>
               <email>AbdulA@VerbaMsftTest.ccsctp.net</email>
               <environmentShortName>Ref.</environmentShortName>
               <extensions>
                  <eid>0000</eid>
                  <environmentShortName>Ref.</environmentShortName>
                  <extension>iptradeTest2</extension>
                  <id>9</id>
                  <im>false</im>
                  <recordingMode>FULL</recordingMode>
                  <screenCaptureEnabled>false</screenCaptureEnabled>
                  <video>false</video>
                  <voice>true</voice>
               </extensions>
               <externalId/>
               <id>7</id>
               <language>en</language>
               <locked>false</locked>
               <loginName>IPTUser2</loginName>
               <needChangePassword>false</needChangePassword>
               <nonModifiable>false</nonModifiable>
               <passwordExpires>false</passwordExpires>
               <roles>r_quality_management_agent</roles>
               <roles>r_standard_user</roles>
               <timeZone>Europe/Budapest</timeZone>
               <userType>user_type_verba</userType>
               <validFrom>2015-09-15T12:17:00Z</validFrom>
               <validTo>2099-12-31T00:00:00Z</validTo>
            </users>
            <users>
               <agentId/>
               <apiAccessOnly>false</apiAccessOnly>
               <crmUserId/>
               <customDateFormat/>
               <customTimeFormat/>
               <displayName>mate</displayName>
               <eid>0000</eid>
               <email/>
               <environmentShortName>Ref.</environmentShortName>
               <extensions>
                  <eid>0000</eid>
                  <environmentShortName>Ref.</environmentShortName>
                  <extension>+12779</extension>
                  <id>15</id>
                  <im>false</im>
                  <recordingMode>FULL</recordingMode>
                  <screenCaptureEnabled>false</screenCaptureEnabled>
                  <video>false</video>
                  <voice>true</voice>
               </extensions>
               <extensions>
                  <eid>0000</eid>
                  <environmentShortName>Ref.</environmentShortName>
                  <extension>12779</extension>
                  <id>16</id>
                  <im>false</im>
                  <recordingMode>FULL</recordingMode>
                  <screenCaptureEnabled>false</screenCaptureEnabled>
                  <video>false</video>

Example ListUsers transaction. Just count the users in a group.

Example ListUsers transaction. Just count the users in a group.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v2:listUsers>
         <token>YWygO3Nw0LlqWWThMKxBa18G3zQ8HKq3</token>
         <filter>
            <environmentFilter>
               <eid>0000</eid>
               <eidExact>0</eidExact>
               <inactive>0</inactive>
               <!-- <shortName></shortName>
               <shortNameExact></shortNameExact> -->
            </environmentFilter>
            <!--  <extension></extension> -->
            <extensionExact>0</extensionExact>
            <!-- <externalId></externalId> -->
            <externalIdExact>0</externalIdExact>
            <group>Nest group2</group>
            <groupExact>0</groupExact>
            <inactive>0</inactive>
            <justCount>1</justCount> <!-- Just count is TRUE -->
            <!-- <loginName></loginName> -->
            <loginNameExact>0</loginNameExact>
            <!-- <role></role> -->
            <roleExact>0</roleExact>
            <!--
            <skipExtensions>0</skipExtensions>
            <skipGroups>0</skipGroups>
            <skipRoles>0</skipRoles>
            -->
         </filter>
      </v2:listUsers>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:listUsersResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <status>
               <statusCode>OK</statusCode>
            </status>
            <userCount>4</userCount>
         </return>
      </ns2:listUsersResponse>
   </S:Body>
</S:Envelope>