GetUserEvents

Get the Events API events a user 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.

Only access given to the user directly is returned, which is the access that Update User Events changes. An event that one of their groups gives them is not listed here, and is returned by Get Group Events for that group. A user who has no API key has no direct access, and an empty list is returned.

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/user/: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 user. Must be a 24-character hexadecimal id.

Example

Request

curl --request GET \
	--url https://demo.attackforge.com/api/ss/user/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.

• User Not Found or Error Finding User - the user could not be found.

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