Skip to main content
POST
Error

Body

application/json

UserViewCriteria to use for searching.

startRow
integer<int32>
required
maxRows
integer<int32>
required
matchAnyCustomAttribute
boolean
required
sortAscending
boolean
required
includeLockedUser
boolean
required
forManagement
boolean
required
exactMatch
boolean
required
accountOnly
boolean
required
homeLocationName
string
sysidDepartments
integer[]
sysidStatuses
integer[]
sysidRoles
integer[]
emailAddress
string
sysidUserGroups
integer[]
lastName
string
sysidSwitchDevices
integer[]
sysidApplicationUsers
integer[]
customAttribs
CustomAttributeSearch · object[]
sysidTitles
integer[]
sysidHomeLocations
integer[]
sysidBusinessUnits
integer[]
sortColumn
enum<string>
Available options:
FIRST_NAME,
LAST_NAME,
EMAIL,
PHONE,
CITY,
ROLE,
HOME_LOCATION
firstName
string
sysidManagers
integer[]

Response

201 - application/json

Wrapper of UserView values.

com.agilquest.phoenix.shared.data.rest.wrapper.UserViewWrapper

nextStartRow
integer<int32>
required
hasAdditional
boolean
required
views
UserView · object[]