GetUserGroups

This method can be used for the following functionality: Get all groups that a user has access to.

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/user/:id/groups HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Id of the user.

Example:

GET /api/ss/user/5d5b27734a83a708c46f4748/groups HTTP/1.1

Example

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

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X GET 'https://demo.attackforge.com/api/ss/user/5d5b27734a83a708c46f4748/groups' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains an array of groups.

{
   "count": 999,
   "groups":[
      {
         "group_name": "...",
         "group_id": "...",
         "access_level": "...",
         "created": "...",
         "last_updated": "...",
      }
   ]
}