This command returns the user hierarchy for a specified parent user.

This API is available in Guardium V9.5 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/user_hierarchy

GuardAPI syntax

list_user_hierarchy_by_parent_user parameter=value


Parameter Value type Description
create String Valid values:
  • true
  • false
When set to true, returns the value of the users in the format of a create_user_hierarchy statement.
userName String The name of the parent user.
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=
  • 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=

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.

GuardAPI examples

In the following examples, George and Harry are both children of AdminManager.

grdapi list_user_hierarchy_by_parent_user userName=Fred

Sample output

Name: George  Id =        1, Parent =    20000, Child =    20001, Type: user
Name: Harry  Id =        3, Parent =    20000, Child =    20002, Type: user

The same command, but with create=true:

grdapi list_user_hierarchy_by_parent_user userName=AdminManager create=true

Sample output

grdapi create_user_hierarchy userName="George" parentUserName="AdminManager"
grdapi create_user_hierarchy userName="Harry" parentUserName="AdminManager"