List User Groups - BlinkOps Documentation

Retrieve a list of user groups. Note: To pass additional Zabbix parameters, use the Additional Parameters field with the following format:

{
  "params": {
    "output": "extend",
    "selectUsers": "extend"
  }
}

External DocumentationTo learn more, visit the Zabbix documentation.

Basic Parameters

Parameter	Description
Limit	The maximum number of results to return.
Request ID	The ID to send with the request.
Search	The search query to filter events by. For more information about the search supported types, refer to Zabbix data types documentation.
Sort Field	Select the field to sort results by.
Sort Order	Select the sort order.
Status	Select the user group status to filter results by.
User Group IDs	A comma-separated list of user group IDs to filter results by.
User IDs	A comma-separated list of user IDs to filter results by.

Advanced Parameters

Parameter	Description
Additional Parameters	A JSON object for additional body parameters. Values specified in this parameter will override equivalent parameters. For example: `{ “first_key”: 12345, “second_key”: “some_value” }` The object must follow the vendor’s structure as defined in the API documentation.

Example Output

{
	"jsonrpc": "2.0",
	"result": [
		{
			"usrgrpid": "7",
			"name": "Zabbix administrators",
			"gui_access": "0",
			"users_status": "0",
			"debug_mode": "1",
			"userdirectoryid": "0",
			"mfa_status": "0",
			"mfaid": "0"
		}
	],
	"id": 1
}