Skip to content

Latest commit

 

History

History
10 lines (7 loc) · 16.8 KB

File metadata and controls

10 lines (7 loc) · 16.8 KB

ListUsersRequest

Fields

Field Type Required Description Example
StartIndex long Starting index of the response.
Count long The count of records to be retrieved in a response.
Filter string A filter string passed in the body of the request, narrows search results and supports the combination of logical and comparison operators.
The filter adheres to the pattern filter='field' comparisonType 'value'.

The following comparison types can be used in filter expressions:
* equal: eq
* not equal: ne
* greater than: gt
* greater or equal: ge
* less than: lt
* less than or equal: le

The following fields are filterable:
* userName (eq|ne)
* groups.value (eq|ne)
* active (eq|ne)
* id (eq|nq)
* emails.value (eq|ne)
* meta.lastModified (eq|ne|lt|le|gt|ge)
* meta.created (eq|ne|lt|le|gt|ge)

The following operators are available:
* and
* or
userName eq 'john@example.com' or userName eq 'Matt@example.com'