JavaScript admin.groupGetAuditEventTypeEnabled

MarkLogic 9 Product Documentation
admin:group-get-audit-event-type-enabled

admin:group-get-audit-event-type-enabled(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $event-type as xs:string
) as xs: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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return
  admin:group-get-audit-event-type-enabled($config, $groupid,
        "no-permission")
  (: returns the new enabled status for the No-Permission event-type :)
Powered by MarkLogic Server | Terms of Use | Privacy Policy