MarkLogic 10 Product Documentation
admin:group-delete

admin:group-delete(
   $config as element(configuration),
   $group-ids as xs:unsignedLong*
) as element(configuration)

Summary

This function deletes one or more groups in the configuration.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
group-ids	The IDs of the groups to be deleted. Typically, this is the result of an `admin:group-get-id` call.

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}

Usage Notes

Any group whose ID you pass into this function must not have any hosts belonging to it when the transaction begins, otherwise an exception is thrown. If you need to delete the group, remove its hosts in a separate transaction before calling this function.

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
  admin:group-delete($config, admin:group-get-id($config, "myOldGroup"))

  (: returns the new configuration element -- use admin:save-configuration
     to save the changes to the configuration or pass the configuration
     to other Admin API functions to make other changes.  :)

MarkLogic 10 Product Documentationadmin:group-delete

Summary

Required Privileges

Usage Notes

Example

MarkLogic 10 Product Documentation
admin:group-delete