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

GET /api/ss/group/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Id of the group.

Example:

GET /api/ss/group/5eab99471e18050942c7607a HTTP/1.1

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.

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'

Response

Response contains a group object.

{
   "group": {
      "name": "...",
      "id": "...",
      "group_owner": "...",
      "primary_contact_name": "...",
      "primary_contact_number": "...",
      "primary_contact_email": "...",
      "is_deleted": false,
      "created": "...",
      "created_by": "...",
      "last_modified": "...",
      "projects": [{"name":"...", "id":"..."},{"name":"...", "id":"..."}],
      "members": [{"name":"...", "userId":"...", "accessLevel": "...", "created":"...", "last_updated":"..."}],
      "custom_fields": [{ "key": "...", "value": "..." }]
   }
}