GetGroupEvents

Get the Events API events a group has been given access to.

Only an Administrator can call this route. It cannot be run as another user, who is never an Administrator. The Self-Service API or the Flows module must be enabled.

This is the access held by the group itself, as set on its Other Access page in the application and changed by Update Group Events. Every member of the group who has an API key can subscribe to these events, on top of the events each has been given directly. An archived group gives its members nothing, and cannot be read here.

Each event is returned as it appears in Get Available Events, sorted by name, ignoring case, so the two lists can be compared.

Headers

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

Request

Path Parameters

id - string | required

ID of the group. Must be a 24-character hexadecimal id.

Example

Request

curl --request GET \
	--url https://demo.attackforge.com/api/ss/group/5eacb8450c8d520a8281e539/events \
	--header 'content-type: application/json' \
	--header 'x-ssapi-key: ************'

Response

{
  "count": 999,
  "events": [
    {
      "name": "vulnerability-created",
      "description": "New vulnerability created on a project"
    }
  ]
}

Access and failures

Errors are returned in error, with a count of 0 and an empty list:

• Unauthorized - the caller is not an Administrator.

• Group Not Found or Error Finding Group - the group could not be found. An archived group is not found.

• Error Finding Events - the group's events could not be read.