summaryrefslogtreecommitdiff
path: root/doc/api/users.md
diff options
context:
space:
mode:
authorNick Thomas <nick@gitlab.com>2017-06-01 17:14:39 +0100
committerNick Thomas <nick@gitlab.com>2017-06-02 18:28:12 +0100
commitc890c6aaf2939bc19292947bd8268d724fa7ddce (patch)
tree246f57f6c492801687adb9effd790f59a2d0909b /doc/api/users.md
parent1bf76c7620396b5cbc59b168a67a4de3102457b3 (diff)
downloadgitlab-ce-c890c6aaf2939bc19292947bd8268d724fa7ddce.tar.gz
Allow users to be hard-deleted from the API
Diffstat (limited to 'doc/api/users.md')
-rw-r--r--doc/api/users.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api/users.md b/doc/api/users.md
index 331f9a9b80b..7e118dcf4a9 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -300,6 +300,9 @@ DELETE /users/:id
Parameters:
- `id` (required) - The ID of the user
+- `hard_delete` (optional) - If true, contributions that would usually be
+ [moved to the ghost user](../user/profile/account/delete_account.md#associated-records)
+ will be deleted instead, as well as groups owned solely by this user.
## User