Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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


Descriptor

Value

HTTP Method

POST

Description

Updates group in system.

Required Permission

Manage Groups

Version Introduced2.6.2

...

Parameter

Value

Required

Description

name

String

Yes

Updates name of the group. Maximum 40 characters. Cannot be used to update name of LDAP group.

globalRoleIdStringNoAdds 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:

Code Block
themeEclipse
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:

...