create_ad_hoc_audit_for_security_assessment

This API creates a security assessment (and if needed, an audit process) for one or more specified datasources.

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/ad_hoc_audit_for_security_assessment

GuardAPI syntax

create_ad_hoc_audit_for_security_assessment parameter=value

Parameters

Parameter Value type Description
datasourcesPar String A list of comma-separated datasource IDs. The security assessment runs all available tests of each datasource based on the datasource type.
includeUserReceiver Boolean Create a receiver for the logged-in user. Valid values:
  • 0 (false)
  • 1 (true)
processNamePar String The name of the audit process. If you do not specify an audit process name, Guardium creates the audit process and security assessment with the following names:
  • Audit process - Audit_SA_U_userId.
  • Security assessment - SA_U_userId.
If you specify an audit process name, Guardium checks to see whether a security assessment with the same name as the audit process exists. If an audit process exists, but a security assessment does not, Guardium creates the security assessment.
sendToEmails String The type of content to send to users on the sendToEmails list. Valid values:
  • 0: PDF
  • 1: CSV
ticketAssignToGroup String If ticketReceiver is set to 1 (true), create an external ticket, assign the ticket to the specified group name or ID, and send the ticket to the external ticketing system (ServiceNow).
ticketAssignToMember String If ticketReceiver is set to 1 (true), create an external ticket, assign the ticket to the specified member name or ID, and send the ticket to the IBM Resilient external ticketing system.
ticketAssignToUser String If ticketReceiver is set to 1 (true), create an external ticket, assign the ticket to the specified username or ID, and send the ticket to the ServiceNow external ticketing system.
ticketReceiver Boolean If set to 1, add a receiver of type Ticket to the audit process result. When the audit process runs, Guardium creates a ticket and attaches the audit process result (as a PDF). Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)

Example

For this example, datasourcesPar=20000 represents the DATASOURCE_ID of an existing Guardium security assessment datasource.

grdapi create_ad_hoc_audit_for_security_assessment processNamePar=psa datasourcesPar=20000 sendToEmails="joan.darcy@mycompany.com" ticketReceiver=1 ticketAssignToGroup="database"