/
UserFilter (v3)

UserFilter (v3)

Overview

Used to filter users.

Members

Member variables of the entity:

MemberType

Description

Requirements
userIdInteger

justCountbooleanIf true the call only counts the users
environmentFilterEnvironmentFilterFilter the tenants we are searching in
loginNameStringLoginName we are searching for
loginNameExactbooleanIf true the loginName parameter represents a complete loginName, not a filter
extensionStringPhone number to search for
extensionExactbooleanIf true the extension parameter represents a complete phone number, not a filter
externalIdString

externalIdExactboolean

groupString

groupExactboolean

roleString

roleExactboolean

skipExtensionsbooleanIf true extensions are not returned
skipGroupsboolean

skipRolesboolean

inactivebooleanIf true we are searching inactive users

Related content

UserFilter (v2)
More like this
ExtensionFilter (v3)
ExtensionFilter (v3)
More like this
EnvironmentFilter (v3)
EnvironmentFilter (v3)
More like this
GroupFilter (v3)
GroupFilter (v3)
More like this
ListUsers (v3)
More like this
ListUsers (v2)
More like this