For the complete documentation index, see llms.txt. This page is also available as Markdown.

Restore User

Description

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

  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

  • Restore the user jane.smith@example.com.

  • Bob is back - reinstate his account.

  • Which users are deleted? Restore the one called Smith.

Parameters

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

Last updated