XQuery admin:group-set-audit-role-restriction

MarkLogic 12 Product Documentation
admin.groupSetAuditRoleRestriction

admin.groupSetAuditRoleRestriction(
   config as element(configuration),
   group-id as (Number|String),
   restriction-type as String,
   roles as String[]
) as element(configuration)

Summary

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

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").
roles	The sequence of roles 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');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.groupSetAuditRoleRestriction(config, groupid,
        "exclusion",("adminRole","developerRole"))

   //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.

MarkLogic 12 Product Documentationadmin.groupSetAuditRoleRestriction

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin.groupSetAuditRoleRestriction