Loading TOC...

admin.groupSetAuditUserRestriction

admin.groupSetAuditUserRestriction(
   $config as element(configuration),
   $group-id as (Number|String),
   $restriction-type as String,
   $users as String[]
) as element(configuration)

Summary

This function restricts the audit configuration by excluding or including by user.

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.
$restriction-type The restriction type (must be one of: "inclusion" or "exclusion").
$users The sequence of users affected by the restriction type.

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');
  var config = admin.getConfiguration()
  var groupid = admin.groupGetId(config, "Default")
  admin.groupSetAuditUserRestriction(config, groupid,
        "exclusion",("admin1","admin2"))

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