AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetGroup
This method can be used for the following functionality: Get details for a group including projects & members assigned to it.

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/group/:id HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

id (string)
Id of the group.
Example:
1
GET /api/ss/group/5eab99471e18050942c7607a HTTP/1.1
Copied!

Example

The following example is a cURL request to get all details for a group.

Request

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

Response

Response contains a group object.
1
{
2
"group": {
3
"name": "...",
4
"id": "...",
5
"group_owner": "...",
6
"primary_contact_name": "...",
7
"primary_contact_number": "...",
8
"primary_contact_email": "...",
9
"is_deleted": false,
10
"created": "...",
11
"created_by": "...",
12
"last_modified": "...",
13
"projects": [{"name":"...", "id":"..."},{"name":"...", "id":"..."}],
14
"members": [{"name":"...", "userId":"...", "accessLevel": "...", "created":"...", "last_updated":"..."}]
15
}
16
}
Copied!
Last modified 1yr ago