AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetGroups
This method can be used for the following functionality: Get details for all groups this user is a member of.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

1
GET /api/ss/groups HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Example

The following example is a cURL request to get all groups user is a member of.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X GET 'https://demo.attackforge.com/api/ss/groups' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Copied!

Response

Response contains an array of group objects.
1
{
2
"count": 999,
3
"groups":[
4
{
5
"group_name": "...",
6
"group_owner": "...",
7
"group_primary_contact_name": "...",
8
"group_primary_contact_number": "...",
9
"group_primary_contact_email": "...",
10
"group_id": "..."
11
}
12
]
13
}
Copied!
Last modified 1yr ago