Modifying a Group

Administrators can use this API to modify the details of an existing group.

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

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	Example with Default key values: { "groupname":"MGRGroup", "disassociateelements":"IIS Web:iis1:80" } Example with both Default and Optional Key Values: { "groupname":"MGRGroup", "disassociateelements":"IIS Web:iis1:80", "associateelements":"Active Directory:ad:1234" }
Body	Default: { "groupname":"Group name", "disassociateelements":"Elements" }
	Optional: { "associateelements":"Elements" }

 

Success Response

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

 

Failure Response

Type	Code	Content
JSON	401 UNAUTHORIZED	{ "Error": "One or more invalid elements to associate. Invalid elements" }

Figure 1 : Example to modify the details of a group using Postman REST Client

Modifying a Group using cURL

To the details of 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/modifygroup" -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', 'disassociateelements':'Elements', 'associateelements':'Elements'}"

Note that the command specified above contains both the Default and Optional key values. shows an example of the details of an existing group using cURL.

Figure 2 : Modifying the details of an existing group using cURL