Loading TOC...

admin.groupSetAuditOutcomeRestriction

admin.groupSetAuditOutcomeRestriction(
   config as element(configuration),
   group-id as (Number|String),
   outcome as String[]
) as element(configuration)

Summary

This function restricts the audit configuration by auditing events only if they are "success" or "failure" events.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group. Typically, this is the result of an admin:group-get-id call.
outcome The outcomes to audit (must be one of: "success" or "failure" or "both").

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group-security

http://marklogic.com/xdmp/privileges/admin/group-security/{id}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.groupSetAuditOutcomeRestriction(config, groupid,
        "failure")

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.  
  

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.