Edit Group - API

/rest/{version}/groups/{groupId}/update

Descriptor	Value

Descriptor	Value
HTTP Method	POST
Description	Updates group in system. To obtain the groupId value in the endpoint, run the Get Groups - API call first. The group's id value in the response is the groupId value that you use in this endpoint.
Required Permission	Manage Groups
Version Introduced	2.6.2

Request Header Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
Accept	String	Yes	A value of ‘application/json’ must be provided.

Request POST Data Parameters

Parameter	Value	Required	Description

Parameter	Value	Required	Description
name	String	Yes	Updates name of the group. Maximum 40 characters. Cannot be used to update name of LDAP group.
globalRoleId	String	No	Adds group's global role. Possible values are 0 for Read Access, -1 for No Global Access, Role ids. Assigns role to group upon creation. By default assigns Role configured in System settings.

Sample Call:

curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'name=testchanged&globalRoleId=1' http://localhost:8080/threadfix/rest/latest/groups/89/update

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Successfully updated group: 89"
}