getAllUsers
Gets all users in an array.
Syntax
Authorized User Types
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
ImagePortalAdmin
Parameters
Input (getAllUsersParam)
Name
Type
Required
Description
includeInvalid
xsd:boolean
Yes
Set to:
- true to include invalid users.
- false to omit invalid users.
Output (getAllUsersReturn)
Name
Type
Required
Description
userArray
types:UserArray
Yes
Array of all users.
Code Phrase
Code Phrase
Examples
This code sample returns all users. The response is truncated for brevity.
Request
<ns1:getAllUsersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:includeInvalid>false</ns1:includeInvalid>
</ns1:getAllUsersParam>
Response
<ns1:getAllUsersReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:userArray>
<ns1:items>
<ns1:userHandle>201|agentshadi@hotmail.com</ns1:userHandle>
<ns1:firstName>333</ns1:firstName>
<ns1:lastName>333</ns1:lastName>
<ns1:email>my_email@someaddress.com</ns1:email>
<ns1:role>TrialSiteUser</ns1:role>
<ns1:isValid>true</ns1:isValid>
<ns1:passwordExpires>2006-12-29T04:19:43.039Z</ns1:passwordExpires>
</ns1:items>
...
</ns1:userArray>
<ns1:getAllUsersReturn>
4e9b9d8c-5839-4215-aa35-01b652869681