> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/attackforge-enterprise/actions.md). # Actions

## Overview *Actions* enable you to build your own *custom workflows* into the AttackForge application user interface, and trigger those workflows with a button click. You can create Actions to *help you*: * **Build custom workflows for your teams** * **Trigger a process automation** * **Launch an integration with an external system** Examples of Actions could include: * Request a QA review / Approve a QA review * Launch scans within your security tooling * Create bulk actions which do not currently exist * Trigger a custom vulnerability risk acceptance workflow * Enable low-privileged users to perform isolated privileged tasks * Export data on-demand * Run custom reports and email the results * Anything you can imagine :smile:

> **IMPORTANT**: Actions are only available if you have the [Flows](/attackforge-enterprise/modules/flows.md) module enabled ## How Actions Work Actions are located in your existing menus, alongside other existing system actions.

Actions are triggered with a *button click*. When triggering an Action, a confirmation dialogue will appear:

This dialogue provides you with additional information on the Action, depending on your configured access. After you click on `Run` - the Action will be triggered, and it will show in your `Action Runs Manager`. From here, you can monitor the status of your triggered Action.

You can click on the status to see more information:

Actions are powered by [Flows](/attackforge-enterprise/modules/flows.md). Flows is AttackForge's *powerful workflow automation engine*, allowing users to create completely custom workflows, automations and integrations. Flows is powered by [AFScript](/attackforge-enterprise/afscript.md) - AttackForge's *easy-to-use scripting language*, creating infinite possibilities with what your Flows can actually do. Actions can be linked to multiple Flows - meaning many workflows can be triggered from one single Action. ## Supported Entities Actions can be created and accessed within any of the following entities: 1. [Project Request(s)](https://support.attackforge.com/attackforge-enterprise/getting-started/requesting-a-project) 2. [Project(s)](https://support.attackforge.com/attackforge-enterprise/getting-started/creating-and-managing-projects) 3. [Project Vulnerability(s)](https://support.attackforge.com/attackforge-enterprise/getting-started/creating-vulnerabilities) 4. [Project Test Case(s)](https://support.attackforge.com/attackforge-enterprise/getting-started/test-cases) 5. [Portfolio(s)](https://support.attackforge.com/attackforge-enterprise/modules/portfolios) 6. [Portfolio Stream](https://support.attackforge.com/attackforge-enterprise/modules/portfolios) 7. [Group(s)](https://support.attackforge.com/attackforge-enterprise/modules/groups) 8. [Asset(s)](https://support.attackforge.com/attackforge-enterprise/modules/assets) 9. [Writeup(s)](https://support.attackforge.com/attackforge-enterprise/modules/vulnerability-library) 10. [User(s)](https://support.attackforge.com/attackforge-enterprise/modules/users) 11. [Application](#application-actions) ## User Actions vs. System Actions **User Actions** are Actions which the user has configured for themselves (in `blue` below). **System Actions** are Actions which the administrators have configured for other Roles, Groups or Users (in `green` below). System Actions are intended to be workflows which administrators can roll out to their users, without their users having to first accept or assign the Action.

## Building Actions To start building an Action, click on the `Actions button` in any of the application menus:

Then click on the `Add Actions` button:

Alternatively, you can click on the `Application Actions` menu from the main navigation bar, then click on the `Actions button`:

Then click on the `New` button:

### Configuring the Action 1. Enter a name for your Action. 2. Select the entities where you want your Action to show.

3. Link the related [Action Event Flows](https://support.attackforge.com/attackforge-enterprise/modules/flows#action-events) to your Action. There is *no limit* on how many Action Event Flows can be linked to your Action.

4. Add an optional **Readme** if required.

5. Review the Action configuration and click `Create`.

If you are seeing the warning `Flow is disabled` - you will need to *enable the Flow* from the [Flows](/attackforge-enterprise/modules/flows.md) module.

If you are seeing the warning `Missing access to trigger action flows` - you will need to assign yourself with either `Run` or `Create` access to [Action Triggers](https://support.attackforge.com/attackforge-enterprise/modules/flows#getting-access-to-flows).

## Triggering Actions Wherever you see an `Actions button` within the application user interface - you can click it to access existing Actions which you can trigger.

When you click on an Action, a confirmation dialogue box will open. You can click `Run` to trigger the Action.

You can click on `Readme` to access more information on this Action.

If you have permission to view the linked Flow, you can click on the button to access it:

After you click on `Run` - the Action will show in your `Action Runs Manager`. From here, you can monitor the status of your triggered Action.

You can click on the status to see more information:

If you have permission to view [Flow Run Logs](https://support.attackforge.com/attackforge-enterprise/modules/flows#run-logs) - you can click the button to see the detailed information for what each Flow did:

### Status Check Issues If a status check returns an issue - you will *not be able to trigger the Action*. If you are seeing the warning `Flow is disabled` - you will need to *enable the Flow* from the [Flows](/attackforge-enterprise/modules/flows.md) module.

## Viewing All Actions You can view all of your Actions by clicking on the `Actions button` from the main navigation menu, then again on the `Actions button:`

You can click on an Action to view the [Action Runs](#viewing-action-runs) related to the Action. You can also view the `Readme` and edit the Action from here.

### Editing Actions When viewing an Action, click on the Edit button to make updates:

You can also access the Edit Action page by clicking on the `Add Actions` button in the Actions menu, then selecting your Action and clicking on the `Edit` button:

### Deleting Actions From the All Actions page, use the table row menu to select the Action you want to delete and then click on `Delete`.

### Viewing Action Runs You can switch to the Action Runs menu from the All Actions page:

You can also view all Action Runs by clicking on an Action from the All Actions page:

When you click on an Action Run - you can see which Flows were triggered and their status. If you have permission - you can click on the button next to the status to view the [Flow Run Logs](https://support.attackforge.com/attackforge-enterprise/modules/flows#run-logs).

## Application Actions Application Actions are accessed by clicking on the `Actions button` from the main navigation menu:

Application Actions relate to the application itself, they are not tied to any particular entity such as a Project, Vulnerability or Asset. You can use Application Actions *at any time* - regardless of what access you have to other data and workflows in AttackForge. This makes them ideal for have personal workflows, or delegating privileged workflows to lower-privileged users. ## Action Owner The Action Owner is the user who created the Action. The Action Owner can manage access to their Action, as well as delete the Action. > **IMPORTANT**: All administrators inherit [Action Owner](#action-owner) privileges on all System Actions. ## Sharing Actions Actions can be created as either [System Actions](#user-actions-vs.-system-actions) or as [User Actions](#user-actions-vs.-system-actions). Actions can be shared as follows: * Admins can share Systems Actions with other Roles, Groups or Users. * Admins can share their User Actions with other Roles, Groups or Users. * Non-Admins can share their User Actions with their own Groups and other Users. ### System Actions Administrators can create, update, delete and share System Actions. > **IMPORTANT**: All administrators inherit [Action Owner](#action-owner) privileges on all System Actions. #### Creating and Sharing a System Action Start by clicking on the Actions button in the main navigation menu, then click on `All Actions`:

Switch to the `System Actions` section, then click on `New`:

Fill in the details and click `Create`.

Once the Action has been created, click on `Share`:

Click on `Add Access`:

Select either `Roles, Groups or Users`:

Select `Access Level`:

* **None** - This setting should be considered as a blocklist or denylist, and used to ensure that under no circumstances should the recipient be able to [trigger the Action](#triggering-actions) when the `Override is set to 'Yes'`. This option is particularly useful as Actions can be shared with Roles and Groups, therefore users can excluded from the inherited access. * **View** - View access allows the recipient to be able to [trigger the Action](#triggering-actions). * **Edit** - Edit access allows the recipient to be able to [trigger the Action](#triggering-actions) and to also edit the [Action configuration](#configuring-the-action). For Users - select the `Override`:

Override is an option that will guarantee the assigned access will prevail for the specified user. This option is particularly useful as Actions can be shared with Roles and Groups, therefore users can inherit access to Actions, and in some cases, this may not be desired for certain users. Overwrite can be used to ensure the user will not be able to access the Action irrespective of whether they inherited access through their Role or Groups. Once you are done, click on `Add` to assign the access.

#### Switching a System Action to User Action Administrators can switch an Action between a System Action or User Action at any time as required:

### User Actions All users can create, update, delete and share their own User Actions. > **IMPORTANT**: All administrators inherit ability to view all User Actions, including its Runs and access controls. Administrators cannot edit User Actions which they do not have Edit access to. #### Creating and Sharing a User Action Start by clicking on the Actions button in the main navigation menu, then click on `All Actions`:

Switch to the `User Actions` section, then click on `New`:

Fill in the details and click `Create`.

Once the Action has been created, click on `Share`:

Click on `Add Access`:

Select either `Groups or Users.` Administrators are able to select an existing user in the system. Non-administrators are required to enter in the email address for an existing user. Non-administrators can only select from Groups that they are members of.

Select `Access Level`:

* **None** - This setting should be considered as a blocklist or denylist, and used to ensure that under no circumstances should the recipient be able to [trigger the Action](#triggering-actions) when the `Override is set to 'Yes'`. This option is particularly useful as Actions can be shared with Groups, therefore users can excluded from the inherited access. * **View** - View access allows the recipient to be able to [trigger the Action](#triggering-actions). * **Edit** - Edit access allows the recipient to be able to [trigger the Action](#triggering-actions) and to also edit the [Action configuration](#configuring-the-action). For Users - select the `Override`:

Override is an option that will guarantee the assigned access will prevail for the specified user. This option is particularly useful as Actions can be shared with Groups, therefore users can inherit access to Actions, and in some cases, this may not be desired for certain users. Overwrite can be used to ensure the user will not be able to access the Action irrespective of whether they inherited access through their Groups. Once you are done, click on `Add` to assign the access.

The Groups and Users with access to the Action will now be able to select the Action from their catalogue. To open the catalogue, click the `Add Actions` button on the Actions menu for the related Action [Entities](#supported-entities):

Find the new Action within the catalogue, then click on `Add`:

The user will now be able to trigger the Action:

### Effective Access Effective access is the place where you can definitively determine which users have access to an Action - depending on which Roles, Groups and Users have been assigned to the Action. Effective access is available to the [Action Owners](#action-owner) and can be accessed from the Action settings page, then click on `Effective Access`:

## Custom Forms on Actions > **Coming soon!** ## Reordering Actions You can re-order your custom Actions by clicking on the `Add Actions` button in the Actions menu:

You can drag-and-drop each row to the order you desire; or use the menu to select the desired re-ordering option - or remove the Action entirely from your Actions menu.

## Transferring Actions Only the [Action Owner](#action-owner) can transfer ownership to another user. [System Actions](#user-actions-vs.-system-actions) can only be transferred to other Administrators. You can transfer an Action by visiting the settings page for the Action, and clicking on `Transfer`:

Administrators are able to select an existing user in the system to transfer the Action to:

Non-administrators are required to enter in the email address for an existing user:

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://support.attackforge.com/attackforge-enterprise/actions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.