UserFilter (v2)

UserFilter (v2)

Overview

Used to filter users.

Members

Member variables of the entity:

Member

Type

Description

Requirements

Member

Type

Description

Requirements

userId

Integer

 

 

justCount

boolean

If true the call only counts the users

 

environmentFilter

EnvironmentFilter

Filter the tenants we are searching in

 

loginName

String

LoginName we are searching for

 

loginNameExact

boolean

If true the loginName parameter represents a complete loginName, not a filter

 

extension

String

Phone number to search for

 

extensionExact

boolean

If true the extension parameter represents a complete phone number, not a filter

 

externalId

String

 

 

externalIdExact

boolean

 

 

group

String

 

 

groupExact

boolean

 

 

role

String

 

 

roleExact

boolean

 

 

skipExtensions

boolean

If true extensions are not returned

 

skipGroups

boolean

 

 

skipRoles

boolean

 

 

inactive

boolean

If true we are searching inactive users