Renaming a Group

Use this API to rename an existing group in eG Enterprise.

URL: http://<eG manager IP:port>/api/eg/orchestration/renamegroup

Method: POST

Content-Type: application/json

Inputs to be Specified

Parameters	Key values	Example
Headers	managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port> user: eG username or domain/eG username pwd: Base64 encoded password	{ "groupname":"westgroup", "newgroupname":"West_group" }
Body	Default: { "groupname":"Group name", "newgroupname":"New group name" }

 

Success Response

Type	Code	Content
JSON	200	{ "Succeed": "Group has been renamed successfully." }

 

Failure Response

Type	Code	Content
JSON	401 UNAUTHORIZED	{ "Error": "The given group does not exist." }

Figure 1 : Example to rename a group using Postman REST Client

Renaming a Group using cURL

To rename an existing group through the REST API using cURL, the command should be specified in the following format:

curl --location --request POST "http://<eG Manager IP:Port>/api/eg/orchestration/renamegroup" -H "managerurl:http://<eG Manager IP:Port>" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "Content-Type: application/json" --data-raw "{'groupname':'Group name', 'newgroupname':'New group name'}"

Figure 2 shows an example of renaming a group using cURL.

Figure 2 : Renaming a group using cURL