> 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/ai-mcp-and-skills/restore-user.md).

# Restore User

#### Description <a href="#description" id="description"></a>

Restores an AttackForge user that was previously deleted by `delete_user`. This is a **write** operation: the account is reactivated, its email address is marked verified again, any account expiry is cleared, and the user reappears in the normal user listings. Any access token the account still holds is revoked, so the user has to sign in again.

The shape of `args` is declared inline (see Building args for Write Tools), so no preparatory call is needed. Deleted users are hidden from `find_users` unless `include_deleted` is set, so use that to find the id to restore.

Preconditions: the caller must be an administrator, and the tenant must be within its user licence limit for the role the user held when it was deleted. On success the user id is returned together with an `updated` flag.

#### How To Enable <a href="#how-to-enable" id="how-to-enable"></a>

1. Go to `Users`
2. Select the user you would like to provide access to this tool
3. Click on `Access > MCP`
4. Click on `Add Tools`
5. Select the tool `restore_user` and click `Add`

#### Example Prompts <a href="#example-prompts" id="example-prompts"></a>

* *Restore the user <jane.smith@example.com>.*
* *Bob is back - reinstate his account.*
* *Which users are deleted? Restore the one called Smith.*

#### Parameters <a href="#parameters" id="parameters"></a>

| Parameter | Type   | Required | Description                                    |
| --------- | ------ | -------- | ---------------------------------------------- |
| `args`    | object | Yes      | The user-restore payload - see the keys below. |

**`args` keys:**

| Key       | Type   | Required | Description                                                                                                                                                     |
| --------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | string | Yes      | Id (24-hex) of the deleted user to restore. Source: `find_users` called with `include_deleted` set to `true`, since a deleted user is otherwise hidden from it. |

> `updated` is `true` when the user was actually restored by this call. `false` means the call succeeded but changed nothing because the user was not deleted in the first place - it is not an error and the call should not be retried.

#### Example Response

```json
{
  "user_id": "65a440c08cade68ca7bc7192",
  "updated": true
}
```


---

# 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, and the optional `goal` query parameter:

```
GET https://support.attackforge.com/app/modules/ai-mcp-and-skills/restore-user.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.