admin.groupCopy

admin.groupCopy(
   config as element(configuration),
   group-id as (Number|String),
   group-name as String
) as element(configuration)

Summary

This function creates a new group specification with the same settings as the group with the specified ID. The new group configuration will have the specified name.

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.
group-name	The name of the new group to create.

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()
  admin.groupCopy(config, admin.groupGetId(config, "myOldGroup"),
                    "myNewGroup")

   //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.