MarkLogic 9 Product Documentation
admin.groupSetName

admin.groupSetName(
   config as element(configuration),
   group-id as (Number|String),
   value as String
) as element(configuration)

Summary

This function changes the name of the group with the specified ID to 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.
value	The new name for the group.

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.groupSetName(config, groupid, "myNewGroupName")

   //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.

MarkLogic 9 Product Documentationadmin.groupSetName

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.groupSetName