XQuery admin:group-get-audit-event-type-enabled

MarkLogic 9 Product Documentation
admin.groupGetAuditEventTypeEnabled

admin.groupGetAuditEventTypeEnabled(
   config as element(configuration),
   group-id as (Number|String),
   event-type as String
) as Boolean

Summary

This function returns the audit event type's enabled setting for the audit configuration. A value of true is returned is the specified event type is set. Otherwise false is returned.

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.
event-type The event type to check (must be one of: amp-usage, audit-configuration-change, audit-shutdown, audit-startup, authentication-failure, concurrent-request-denial, configuration-change, document-execute, document-insert, document-read, document-update, estimate, eval, exists, lexicon-read, no-permission, no-privilege, permission-change, request-blackout-denial, role-change-failure, search, security-access, server-restart, server-shutdown, server-startup, user-configuration-change, user-role-addition, user-role-removal, HTTP-client-authentication-failure, LDAP-client-authentication-failure, SMTP-client-authentication-failure ).

Required Privileges

This operation requires at least one of the following privileges:

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

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var groupid = admin.groupGetId(config, "Default")
  admin.groupGetAuditEventTypeEnabled(config, groupid,
        "noPermission")

   //returns the new enabled status for the NoPermission eventType
Powered by MarkLogic Server | Terms of Use | Privacy Policy