Actions
List System Users
This endpoint returns all systemusers.
Sample Request
Basic Parameters
Parameter | Description |
---|---|
Fields | The space separated fields included in the returned records.If omitted the default list of fields will be returned. |
Filter | A filter to apply to the query. See the supported operators below. For more complex searches,see the related /search/<domain> endpoints,e.g. /search/systems .Filter structure: <field>:<operator>:<value> .field = Populate with a valid field from an endpoint response.operator = Supported operators are:- $eq (equals)- $ne (does not equal)- $gt (is greater than)- $gte (is greater than or equal to)- $lt (is less than)- $lte (is less than or equal to)*Note: v1 operators differ from v2 operators.__Note: For v1 operators, excluding the $ will result in undefined behavior.*value = Populate with the value you want to search for. Is case sensitive.Examples- GET /users?filter=username:$eq:testuser - GET /systemusers?filter=password_expiration_date:$lte:2021-10-24 - GET /systemusers?filter=department:$ne:Accounting - GET /systems?filter[0]=firstname:$eq:foo&filter[1]=lastname:$eq:bar - this will AND the filters together.- GET /systems?filter[or][0]=lastname:$eq:foo&filter[or][1]=lastname:$eq:bar - this will OR the filters together. |
Search | A nested object containing a searchTerm string or array of strings and a list of fields to search on. |
Sort | The space separated fields used to sort the collection.Default sort is ascending, prefix with - to sort descending. |
Advanced Parameters
Parameter | Description |
---|---|
Limit | The number of records to return at once. |
Organization ID | Organization identifier that can be obtained from console settings. |
Skip | The offset into the records to return. |
Example Output
Workflow Library Example
List System Users with Jumpcloud and Send Results Via Email
Preview this Workflow on desktop
Was this page helpful?