UpdateGroupEvents

Grant a group access to Events API events, or revoke it.

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

Events are named as in the Events API, e.g. 'vulnerability-created'. Get Available Events lists every name that is accepted, and Get Group Events lists the ones the group has now. A later operation on the same event wins.

The access is held by the group, as on its Other Access page in the application, and every member of the group who has an API key can subscribe to its events on top of their own. No member is changed or given an API key, so a member without one cannot subscribe to the group's events. An event that a member has been given directly, or by another group, stays available to them after it is removed here.

Headers

PATCH /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.

Body

operations - list of objects | required

Delegations to grant or revoke. At least one operation is required.

• events - list of strings | required

  • List of event names. At least one is required.

• type - string | required

  • Must be either 'add' or 'remove'

Example

Request

curl --request PATCH \
	--url https://demo.attackforge.com/api/ss/group/5eacb8450c8d520a8281e539/events \
	--header 'content-type: application/json' \
	--header 'x-ssapi-key: ************' \
	--data '{
		"operations":[
			{
				"type":"add",
				"events":[
					"vulnerability-created",
					"vulnerability-updated"
				]
			},
			{
				"type":"remove",
				"events":[
					"project-created"
				]
			}
		]
	}'

Response

{
  "status": "ok | error",
  "error": "..."
}

Access and failures

Errors are returned in error:

• 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.

• Unknown events: a, b - an event is not one of the Events API events. Nothing is applied.

• Error Granting Events or Error Revoking Events - the change could not be saved. Events are granted before any are revoked, so a revoking error means the grants were applied.