MarkLogic 10 Product Documentation
admin:group-set-name

admin:group-set-name(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $value as xs: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


  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-set-name($config, $groupid, "myNewGroupName")

  (: 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-set-name

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:group-set-name