Loading TOC...


   config as element(configuration),
   group-ids as (Number|String)[]
) as element(configuration)


This function deletes one or more groups in the configuration.

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:



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.


  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  admin.groupDelete(config, admin.groupGetId(config, "myOldGroup"))

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