PatchUserFlowTriggerAccess

Set the access a user has to each kind of flow trigger.

Only an Administrator can call this route, and it cannot be run as another user. The Flows module must be enabled.

Each level is 'Create', 'Run' or 'None'. At least one must be given, and levels not given are left as they are. A body with no level, or with any other value, is refused with HTTP 400 as described under Errors.

These are the user's own levels. A user who belongs to groups has the highest of their own level and their groups' levels, so 'None' here does not take away access that a group gives. Patch Group Flow Trigger Access sets the levels of a group.

Headers

PATCH /api/ss/user/:id/flow-trigger-access 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.

Body

anonymous_http_trigger_level - string

Access to anonymous HTTP-triggered flows. Must be 'Create', 'Run' or 'None'

authenticated_http_trigger_level - string

Access to authenticated HTTP-triggered flows. Must be 'Create', 'Run' or 'None'

custom_action_trigger_level - string

Access to custom-action-triggered flows. Must be 'Create', 'Run' or 'None'

event_trigger_level - string

Access to event-triggered flows. Must be 'Create', 'Run' or 'None'

scheduled_trigger_level - string

Access to scheduled flows. Must be 'Create', 'Run' or 'None'

Example

Request

curl --request PATCH \
	--url https://demo.attackforge.com/api/ss/user/5eacb8450c8d520a8281e539/flow-trigger-access \
	--header 'content-type: application/json' \
	--header 'x-ssapi-key: ************' \
	--data '{
		"event_trigger_level":"Run",
		"custom_action_trigger_level":"None"
	}'

Response

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

Access and failures

Errors are returned in error: Unauthorized, Error Finding User, User Not Found or Error Saving Flow Trigger Access.