Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor

/rest/{version}/groups/list


Descriptor

Value

HTTP Method

GET

Description

Returns a list of groups.

Required Permission

Manage Groups

Version Introduced2.5.1.12
Changes in 2.5.2Adds "activeDirectory" attribute to response. This is only present when using version 2.5.2 or later.


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.


Sample Call:

Code Block
themeEclipse
curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" https://localhost:8443/threadfix/rest/latest/groups/list

Sample Output:


Code Block
themeEclipse
{
  "message": "",
  "success": true,
  "responseCode": -1,
  "object": [
    {
      "id": 1,
      "name": "Staff",
      "type": "LDAP"
    },
    {
      "id": 2,
      "name": "Staff",
      "type": "LOCAL"
    }
  ]
}


Page Tree
rootwip - Users, Roles, and Groups API