create_api_parameter_mapping

Guardium® includes a battery of predefined reports. Many reports are mapped to GuardAPI functions to ease configuration. Use this command to define additional reports, including custom reports, and map them to GuardAPI functions for each report.

For more information about mapping GuardAPIs to domains, entities, and attributes, see Mapping APIs to report results.

This API is available in Guardium V9.5 and later.

REST API syntax

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

GuardAPI syntax

create_api_parameter_mapping parameter=value

Parameters

Parameter Value type Description
attributeLabel String Required. An attribute within an entity.
domain String Required. One of the Guardium reporting domains such as Access, Alert, Discovered Instances, Exceptions, or Group Tracking.
entityLabel String Required. The name of the entity within the reporting domain.
functionName String Required. The API function to map.
parameterName String Required. The parameter within the API.
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.

GuardAPI example

grdapi create_api_parameter_mapping functionName="create_group" parameterName="desc" domain="Group Tracking" entityLabel="Group" attributeLabel="Group Description"