Skip to main content
Get a list of users.
External DocumentationTo learn more, visit the Rapid7 InsightIDR documentation.

​
Parameters

ParameterDescription
PageThe number of the page to return results from (zero-based).
Page SizeThe maximum number of results to return per page. Valid range is 1-100
Return All PagesAutomatically fetch all resources, page by page.
SearchAn 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.
SortAn 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"
		}
	]
}

​
Workflow Library Example

List Users with Rapid7 Insightidr and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop