List Users

Get a list of users.

External Documentation

To learn more, visit the Rapid7 InsightIDR documentation.

​

Parameters

Parameter	Description
Page	The number of the page to return results from (zero-based).
Page Size	The maximum number of results to return per page. Valid range is 1-100
Return All Pages	Automatically fetch all resources, page by page.
Search	An array of searching criteria objects to search users with. For Example: [ { “field”: “name”, “operator”: “EQUALS”, “value”: { }#Could be a value of any type. } ] Note: Valid searching fields are - first_name,last_name,name and domain.
Sort	An array of sorting criteria objects to search users with. For Example: [ { “field”: “name”, “order”: “ASC” } ] Note: Valid sorting fields are - first_name,last_name and name.

​

Example Output

{
	"search": [
		{
			"field": "name",
			"operator": "EQUALS",
			"value": {}
		}
	],
	"sort": [
		{
			"field": "name",
			"order": "ASC"
		}
	]
}