list_groups

This API returns details about the groups defined in the local, or specified, Guardium system. The description does not include group members.

This API is available in Guardium V11.2 and later.

REST API syntax

This API is available as a REST service with the GET method. Call this API as follows: 
GET https://[Guardium hostname or IP address]:8443/restAPI/group

GuardAPI syntax

list_groups parameter=value

Parameters

Parameter Value type Description
skipEmpty Boolean Whether or not empty groups are returned. Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)
api_target_host String

Specifies the target hosts where the API executes. Valid values:
  • all_managed: execute on all managed units but not the central manager
  • all: execute on all managed units and the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • host name or IP address of a managed unit: specified from the central manager to execute on a managed unit.  For example, api_target_host=10.0.1.123.
  • host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

Examples

Typical output: 
grdapi list_groups
ID=0
Group Id: 80, Description: "Administrative Programs", Application: "Public", Type: "SOURCE PROGRAM", Hierarchical: false, Member Count: 0, Tuple Count: 1
Group Id: 254, Description: "All Failed Authorization", Application: "Public", Type: "DB Error Codes", Hierarchical: false, Member Count: 7, Tuple Count: 1
Group Id: 17, Description: "ALTER Commands", Application: "Public", Type: "COMMANDS", Hierarchical: false, Member Count: 35, Tuple Count: 1
Group Id: 192, Description: "Analytic Exclude DB User", Application: "Public", Type: "USERS", Hierarchical: false, Member Count: 0, Tuple Count: 1
Group Id: 193, Description: "Analytic Exclude OS User", Application: "Public", Type: "USERS", Hierarchical: false, Member Count: 0, Tuple Count: 1
Group Id: 194, Description: "Analytic Exclude Server IP", Application: "Public", Type: "Server IP", Hierarchical: false, Member Count: 0, Tuple Count: 1