> 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/app/modules/users.md).

# Users

## Overview <a href="#overview" id="overview"></a>

The **Users** module is where Administrators manage everyone who uses AttackForge. From here you can:

* create and invite users
* manage their access to projects, groups, the Self-Service APIs and AI MCP
* update their details
* block or allow them to sign in
* view their login history and audit logs
* delete them

Each role adds to the one before it. Data object privileges then decide which projects, libraries, templates, groups, Flows, Actions, APIs and fields a user can access. People get an account in one of three ways.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2Fhk62iYLxKCiuyVAYnun2%2Fusers-at-a-glance.svg?alt=media&amp;token=1205dd76-f7fd-42b8-915f-f54a30402f67" alt=""><figcaption></figcaption></figure>

## Why it matters <a href="#why-it-matters" id="why-it-matters"></a>

* **One place to manage people.** Onboard, change and offboard users without visiting each project.
* **Least privilege.** Roles decide what each user can do, and data object privileges decide what they can see.
* **Fast offboarding.** Block, expire or delete an account, and access is gone straight away.
* **Accountability.** Login history and audit logs show who did what, and when.

## Who benefits <a href="#who-benefits" id="who-benefits"></a>

| Who                               | How                                                                                        |
| --------------------------------- | ------------------------------------------------------------------------------------------ |
| **Administrators**                | Manage every account, role and permission in one place                                     |
| **Project coordinators**          | Rely on clear roles when inviting people to projects                                       |
| **Security and compliance teams** | Review access, MFA and audit logs                                                          |
| **Users**                         | Get the access they need straight away, with less waiting on admins, thanks to delegations |

## How access works <a href="#how-access-works" id="how-access-works"></a>

AttackForge uses two kinds of access together:

* **Application roles** decide which modules and functions a user can use.
* **Data object privileges** decide which data a user can access, such as portfolios and streams, project requests, projects, asset libraries, writeup libraries, report templates, groups, Flows, Actions, Self-Service APIs, custom fields and project features.

{% hint style="info" %}
Users who aren't Administrators only see the projects and vulnerabilities they've been invited to, or that they can access through a group.
{% endhint %}

## User roles <a href="#user-roles" id="user-roles"></a>

Every user has one of five application roles.

| Role                    | Who it's for                                       | What they can do                                                                                    |
| ----------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| **Client**              | Standard users, such as customers and asset owners | Work on the projects they're invited to, and see their own data                                     |
| **Consultant**          | Standard users, such as testers                    | The same as Clients                                                                                 |
| **Library Moderator**   | Not recommended. See below.                        | The same as Clients and Consultants                                                                 |
| **Project Coordinator** | People who run projects                            | Everything above, plus creating and managing projects, inviting users and handling project requests |
| **Administrator**       | Super users                                        | Full access to everything, including the Administration module                                      |

## Clients and Consultants <a href="#clients-and-consultants" id="clients-and-consultants"></a>

| Area                 | Access                                                                                                                    |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| **Global Dashboard** | Yes                                                                                                                       |
| **Analytics**        | Their own data                                                                                                            |
| **Vulnerabilities**  | The vulnerabilities they can access                                                                                       |
| **Projects**         | Projects they're invited to, and their own project requests                                                               |
| **Scheduling**       | Only their own projects                                                                                                   |
| **Portfolios**       | View only, depending on how each portfolio is set up                                                                      |
| **Assets**           | View or edit, depending on each asset library's settings, and on uncatalogued asset access controls, if they're turned on |
| **Writeups**         | View or edit, depending on each writeup library's settings                                                                |
| **Flows**            | Depending on each Flow's settings                                                                                         |
| **Actions**          | Depending on each Actions's settings                                                                                      |
| **Self-Service API** | No access by default                                                                                                      |
| **Attack Chains**    | Yes                                                                                                                       |
| **Help & Support**   | Yes                                                                                                                       |

## Library Moderators <a href="#library-moderators" id="library-moderators"></a>

Library Moderators have the same access as Clients and Consultants.

{% hint style="info" %}
**Important:** We don't recommend using the Library Moderator role. Library access is now managed with access controls on each library.
{% endhint %}

## Project Coordinators <a href="#project-coordinators" id="project-coordinators"></a>

Project Coordinators have everything Clients and Consultants have, plus:

* **Projects:** create and update projects, optionally be notified of new projects, invite users, and manage users' access to projects
* **Project requests:** approve, request more information, or reject
* **Report templates and test suites:** create, view, update and delete
* **Scheduling:** filter by user and by project role

Flows and the Self-Service API work the same way as for other roles.

## Administrators <a href="#administrators" id="administrators"></a>

Administrators are super users, with full access. They have everything Project Coordinators have, plus:

* **Projects:** archive, unarchive and destroy projects, and carry out every workflow on a project
* **Create, view, update and delete:** portfolios, report templates, writeups, test suites, groups (including group membership), and users (including access logs)
* **Assets:** create, view, update and delete every asset, and see the vulnerabilities on every asset
* **Flows:** see information about every Flow, and view, run or edit each one, depending on its settings
* **Actions:** see information about every Action, and view, run or edit each one, depending on its settings
* **Self-Service API:** no access by default, but Administrators can give access to themselves and to others in the Users module
* **Administration module:** full access to add-ons, tenant configuration, and licensing and support information

## Add users <a href="#add-users" id="add-users"></a>

There are two ways for people to get an account:

|                      | Self-registration                           | Created by an Administrator                  |
| -------------------- | ------------------------------------------- | -------------------------------------------- |
| **Who starts it**    | The user, if self-registration is turned on | An Administrator                             |
| **Email activation** | Required before they can sign in            | Not needed. The account is already verified. |
| **First sign-in**    | Set up two-factor authentication            | Set up two-factor authentication             |
| **Email sent**       | An activation email                         | A Welcome Email                              |

## Deleting and restoring users <a href="#register-as-a-new-user" id="register-as-a-new-user"></a>

When a user is deleted - they will no longer be able to log in, use the APIs or AI MCP, or receive emails. However, any data the user has created within the application, such as creating a vulnerability, will still be available and associated to the user.

When a user is restored - their access will also be restored, as if they were never deleted.

## Register as a new user <a href="#register-as-a-new-user" id="register-as-a-new-user"></a>

If self-registration is turned on, people can register themselves.

1. Register for an account.
2. Activate the account from the email you're sent.
3. Sign in. You'll see a QR code.
4. Scan the QR code with an authenticator app to set up two-factor authentication.

{% hint style="info" %}
Two-factor authentication is required by default. Administrators can turn it off for individual users.
{% endhint %}

## Create a new user <a href="#create-a-new-user" id="create-a-new-user"></a>

Administrators can create users directly, without registration or email activation. New accounts are already verified, so the user can sign in straight away. They're sent a Welcome Email.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FW1r1y7dqy6dFLgkA8V7d%2FScreenshot%202026-11-06%20at%202.12.19%E2%80%AFpm.png?alt=media&amp;token=73c855de-658e-4b4c-95d2-fa0815511fde" alt=""><figcaption></figcaption></figure>

## Update a user <a href="#update-a-user" id="update-a-user"></a>

### Profile <a href="#profile" id="profile"></a>

Administrators can update a user's profile and any custom fields configured for that user.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FKNXYCXf7z2bl947FMocu%2FScreenshot%202026-11-06%20at%202.17.40%E2%80%AFpm.png?alt=media&amp;token=2d8c2645-4825-4a59-9849-644a24b6c5ff" alt=""><figcaption></figcaption></figure>

### Account <a href="#account" id="account"></a>

Administrators can update these account settings for a user:

| Setting                           | What it does                                                                          |
| --------------------------------- | ------------------------------------------------------------------------------------- |
| **Email address**                 | Changes the user's email address                                                      |
| **Username**                      | Changes the user's username                                                           |
| **Password**                      | Sets a new password                                                                   |
| **MFA**                           | Turns multi-factor authentication on or off, or resets it                             |
| **Expiry date**                   | Blocks the account automatically after this date. Useful for contractors and vendors. |
| **Exempt from Inactivity Policy** | If Inactivity Policy is enabled, exempt user                                          |
| **Resend Welcome Email**          | Sends the Welcome Email again                                                         |
| **Block / unblock sign-in**       | Stops the user signing in, or lets them sign in again                                 |
| **Delete**                        | Deletes the user                                                                      |

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FqmQqMzCSG8k0DUQPYyyO%2FScreenshot%202026-11-06%20at%202.13.34%E2%80%AFpm.png?alt=media&amp;token=70ccee33-3cb0-4edc-891d-414a3862c417" alt=""><figcaption></figcaption></figure>

### Manage access <a href="#manage-access" id="manage-access"></a>

Administrators can change a user's role, and manage their access to groups, projects, delegations, the Self-Service Events and RESTful APIs, and AI MCP. You can add access in bulk for each of these.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FfDLa20BW4qDFqHxFiDUg%2FScreenshot%202026-11-06%20at%202.16.44%E2%80%AFpm.png?alt=media&amp;token=e62368c3-b11c-4cb6-92e3-973a014389fb" alt=""><figcaption></figcaption></figure>

#### Groups <a href="#groups" id="groups"></a>

Change or remove the user's permissions on their groups. Changes apply straight away to every project linked to the group. See [Groups](https://support.attackforge.com/app/modules/groups).

#### Projects <a href="#projects" id="projects"></a>

Change or remove the user's permissions on existing projects. Changes apply straight away. Removing a user from a project immediately blocks their access to all of its vulnerabilities and data.

#### Delegations <a href="#delegations" id="delegations"></a>

Delegate specific workflows to trusted users, so they can do them without needing an Administrator. This reduces the load on Administrators. Delegations can be updated, removed or added in bulk.

Some delegations can also be given to a whole application role, in the **Administration** module.

#### Self-Service Events API and RESTful API <a href="#self-service-events-api-and-restful-api" id="self-service-events-api-and-restful-api"></a>

{% hint style="info" %}
**Important:** No user has access to the Self-Service APIs by default, including Administrators. Access is given for each event, or each endpoint.
{% endhint %}

For each API, you can update or remove the user's access to each event or endpoint.

| API                          | Access is given for each | The user's key                                           |
| ---------------------------- | ------------------------ | -------------------------------------------------------- |
| **Self-Service Events API**  | Event                    | Every user can generate or regenerate their own user key |
| **Self-Service RESTful API** | Endpoint                 | Every user can generate or regenerate their own user key |

{% hint style="info" %}
**Tip:** To set up a service account that people can't sign in with, give the account its API access, then block it from signing in. It can still use the Self-Service APIs. See [Working with service accounts](https://support.attackforge.com/app/getting-started/working-with-service-accounts).
{% endhint %}

#### Flows access <a href="#flows-access" id="flows-access"></a>

Flows is included in the Enterprise and Core SME plans. On other plans, you can add it under **Administration > Subscriptions**.

To build a Flow, a user needs **Create** access to Event Triggers or HTTP Triggers. Set each user's access level for each trigger type:

<table data-header-hidden><thead><tr><th></th><th></th><th width="119.015625"></th><th></th><th></th><th></th></tr></thead><tbody><tr><td>Access level</td><td>Event Trigger</td><td>HTTP Trigger, no authentication</td><td>HTTP Trigger, User API Key authentication</td><td>Schedule Trigger</td><td>Action Trigger</td></tr><tr><td><strong>None</strong></td><td>Can't create or import these Flows. Flows they already own don't run.</td><td>Can't create or import these Flows. Flows they already own don't run.</td><td>Can't create or import these Flows. Flows they already own don't run.</td><td>Can't create or import these Flows. Flows they already own don't run.</td><td>Can't create or import these Flows. Flows they already own don't run.</td></tr><tr><td><strong>Run</strong></td><td>Their Flows run, if the Flow is turned on and they have access to the matching event type</td><td>Their Flows run, if the Flow is turned on</td><td>Their Flows run, if the Flow is turned on and a valid user key is sent in the designated header</td><td>Their Flows run, if the Flow is turned on and they have access to the matching event type</td><td>Their Flows run, if the Flow is turned on and they have access to the matching event type</td></tr><tr><td><strong>Create</strong></td><td>Can create and import these Flows. Their Flows run under the same conditions as Run.</td><td>Can create and import these Flows. Their Flows run if the Flow is turned on.</td><td>Can create and import these Flows. Their Flows run under the same conditions as Run.</td><td>Can create and import these Flows. Their Flows run under the same conditions as Run.</td><td>Can create and import these Flows. Their Flows run under the same conditions as Run.</td></tr></tbody></table>

{% hint style="info" %}
**Important:** Administrators always have Create access to every trigger type. This can't be revoked.
{% endhint %}

#### AI MCP access <a href="#notifications-logs-and-preferences" id="notifications-logs-and-preferences"></a>

{% hint style="info" %}
**Important:** No user has access to the AI MCP tools by default, including Administrators. Access is given for each tool.
{% endhint %}

You can update or remove the user's access to each AI MCP tool.

### Applications <a href="#notifications-logs-and-preferences" id="notifications-logs-and-preferences"></a>

When a user has established a session with AttackForge MCP using their AI assistant, their sessions will become visible in `Users > (Select the user) > Applications > MCP Sessions`

Here you can monitor and revoke MCP sessions.

You can also manually enroll a user for access to MCP. See [Manually Registering MCP Clients](https://support.attackforge.com/app/automations-and-integrations/ai-mcp-and-skills#manually-registering-mcp-clients).

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FbhXk7rpFiiI0HWQefkFm%2FScreenshot%202026-11-06%20at%202.35.23%E2%80%AFpm.png?alt=media&amp;token=7e39fee5-8cfb-46d5-a589-11a4bd26e3c8" alt=""><figcaption></figcaption></figure>

### Notifications, logs and preferences <a href="#notifications-logs-and-preferences" id="notifications-logs-and-preferences"></a>

| Section           | What Administrators can do                                                           |
| ----------------- | ------------------------------------------------------------------------------------ |
| **Notifications** | Update a user's project email notification options                                   |
| **Logs**          | View a user's audit logs                                                             |
| **Preferences**   | Set the page a user lands on when they sign in. The default is the Global Dashboard. |

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2F1BTK6SNLdBRidxYK0nTu%2FScreenshot%202026-11-06%20at%202.36.34%E2%80%AFpm.png?alt=media&amp;token=db2965fb-0f25-428f-8e5b-43d80983b7f6" alt=""><figcaption></figcaption></figure>

### Secrets <a href="#secrets" id="secrets"></a>

Secrets are confidential items, such as passwords and API keys, that Flows and integrations use. Keeping them as secrets means you can rotate them in one place, instead of updating every Flow that uses them.

Only the person who created a secret can view it, but they can share it with others. Sharing supports both view and edit permissions.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FLzLEJPDRoO6WfnQSxhe7%2FScreenshot%202026-11-06%20at%202.37.45%E2%80%AFpm.png?alt=media&amp;token=6c1a3048-96e3-4522-86e3-7a76271310fc" alt=""><figcaption></figcaption></figure>

## User API key <a href="#user-api-key" id="user-api-key"></a>

Each user has one API key. It's static and doesn't expire. It works with:

* the [Self-Service RESTful API](https://support.attackforge.com/app/modules/self-service-restful-api)
* the [Self-Service Events API](https://support.attackforge.com/app/modules/self-service-events-api)
* [HTTP Trigger Flows](https://support.attackforge.com/app/modules/flows#external-events)
* [Local MCP](https://support.attackforge.com/app/automations-and-integrations/ai-mcp-and-skills#configuring-local-mcp)

To replace the key, for example if it may have been exposed, click **regenerate**. Anything using the old key stops working until it's updated.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FXYbwpRwSHFbN2u9j4nbT%2FScreenshot%202026-11-06%20at%202.40.35%E2%80%AFpm.png?alt=media&amp;token=ccc05891-2efa-4694-aa5e-1ece11b3e1a5" alt=""><figcaption></figcaption></figure>

## Single sign-on (SSO) <a href="#single-sign-on-sso" id="single-sign-on-sso"></a>

AttackForge supports OAuth2 OpenID Connect (OIDC), with up to two Identity Providers at the same time. SSO is available on Enterprise plans, and is configured and turned on by AttackForge.

### Create users when they first sign in <a href="#create-users-when-they-first-sign-in" id="create-users-when-they-first-sign-in"></a>

With **Auto Create User on Login**, a user's account is created the first time they sign in with SSO, so you don't need to create it in advance. New users get the **Default Role for New Users**. You can turn this off.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FJrlYcJe4KboR0rTeIIGA%2FScreenshot%202026-11-06%20at%202.42.31%E2%80%AFpm.png?alt=media&amp;token=60b411e4-8f95-4e88-9e33-0ef41be59b3f" alt=""><figcaption></figcaption></figure>

### Require MFA for Administrators <a href="#require-mfa-for-administrators" id="require-mfa-for-administrators"></a>

If your Identity Provider doesn't enforce MFA, turn on **Require MFA on Admin SSO Logins**. Administrators then have to complete AttackForge's two-factor authentication when they sign in with SSO.

### Manage roles with SSO groups <a href="#manage-roles-with-sso-groups" id="manage-roles-with-sso-groups"></a>

Map groups in your Identity Provider or Active Directory to AttackForge application roles. Roles are updated every time a user signs in, so role changes in your directory flow through automatically.

Users who aren't in any mapped group get the **Default Role/Action For SSO Users**: **Blocked**, **Client** or **Consultant**.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2Fr22FuzmhqwltbxRs5WnT%2FScreenshot%202026-11-06%20at%202.43.49%E2%80%AFpm.png?alt=media&amp;token=335e98a6-4758-4924-9522-25aa3e04e46b" alt=""><figcaption></figcaption></figure>

### Manage group membership with SSO groups <a href="#manage-group-membership-with-sso-groups" id="manage-group-membership-with-sso-groups"></a>

Link groups in your Identity Provider or Active Directory to AttackForge groups. Membership is updated every time a user signs in, so your organisation's own access control groups decide who can access which projects.

* This is off by default, and is turned on for a group when you add a link to it.
* Once a group is linked, all of its membership is managed through SSO.
* Users in a linked directory group are added to the AttackForge group, with the access level you mapped.
* Members who aren't in a linked directory group are removed.

<figure><img src="https://372186556-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8s1QY2Q6YTHB4a6DMu%2Fuploads%2FHmcnpnZjpE9SqiwRFmVk%2FScreenshot%202026-11-06%20at%202.45.13%E2%80%AFpm.png?alt=media&amp;token=b4a8ff5c-ef43-4fef-8254-1f274df2240c" alt=""><figcaption></figcaption></figure>

## Tips <a href="#tips" id="tips"></a>

* **Give people access through groups**, not one project at a time. It's easier to manage, and to remove.
* **Set an expiry date** on accounts for contractors and vendors, so access ends automatically.
* **Keep two-factor authentication on.** Only turn it off for a user when there's a good reason.
* **Use delegations** to let trusted users handle routine workflows, so Administrators aren't a bottleneck.
* **Don't use the Library Moderator role.** Use access controls on each library instead.
* **With SSO, manage roles and group membership in your directory**, so access changes when people join, move or leave.
* **Review audit logs** when investigating unusual activity.

## FAQ <a href="#faq" id="faq"></a>

**Do Administrators have API access by default?** No. No user has Self-Service API access by default. Administrators can give it to themselves, or to others, in the Users module or via groups.

**What's the difference between registering and creating a user?** Registered users must activate their account from an email before they can sign in. Users created by an Administrator are already verified, and can sign in straight away.

**Is two-factor authentication required?** Yes, by default. Administrators can turn it off for individual users.

**What happens when I remove a user from a project?** They immediately lose access to all of the project's vulnerabilities and data.

**Can a blocked user still use the API?** Yes. Blocking stops a user signing in, but their API access still works. This is how service accounts are set up.

**Does a user's API key expire?** No. It's static and doesn't expire, but it can be regenerated at any time.

**What role do new SSO users get?** The Default Role for New Users. If you manage roles with SSO groups, users who aren't in a mapped group get the Default Role/Action For SSO Users: Blocked, Client or Consultant.

## Related pages <a href="#related-pages" id="related-pages"></a>

* [Groups](https://support.attackforge.com/app/modules/groups)
* [Data concepts and access](https://support.attackforge.com/app/data-concepts-and-access)
* [Working with service accounts](https://support.attackforge.com/app/getting-started/working-with-service-accounts)
* [Invite user to project](https://support.attackforge.com/app/getting-started/invite-user-to-project)
* [Flows](https://support.attackforge.com/app/modules/flows)
* [Actions](https://support.attackforge.com/app/automations-and-integrations/actions.md)
* [AI MCP](https://support.attackforge.com/app/automations-and-integrations/ai-mcp-and-skills.md)
* [Access Control Matrix](https://support.attackforge.com/app/access-control-matrix)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://support.attackforge.com/app/modules/users.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
