Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 576bc65

Browse files
committed
Document the erase status in user_admin_api
1 parent 84f27cf commit 576bc65

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/admin_api/user_admin_api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ It returns a JSON body like the following:
3737
"is_guest": 0,
3838
"admin": 0,
3939
"deactivated": 0,
40+
"erased": false,
4041
"shadow_banned": 0,
4142
"creation_ts": 1560432506,
4243
"appservice_id": null,
@@ -167,6 +168,7 @@ A response body like the following is returned:
167168
"admin": 0,
168169
"user_type": null,
169170
"deactivated": 0,
171+
"erased": false,
170172
"shadow_banned": 0,
171173
"displayname": "<User One>",
172174
"avatar_url": null,
@@ -177,6 +179,7 @@ A response body like the following is returned:
177179
"admin": 1,
178180
"user_type": null,
179181
"deactivated": 0,
182+
"erased": false,
180183
"shadow_banned": 0,
181184
"displayname": "<User Two>",
182185
"avatar_url": "<avatar_url>",
@@ -247,6 +250,7 @@ The following fields are returned in the JSON response body:
247250
- `user_type` - string - Type of the user. Normal users are type `None`.
248251
This allows user type specific behaviour. There are also types `support` and `bot`.
249252
- `deactivated` - bool - Status if that user has been marked as deactivated.
253+
- `erased` - bool - Status if that user has been marked as erased.
250254
- `shadow_banned` - bool - Status if that user has been marked as shadow banned.
251255
- `displayname` - string - The user's display name if they have set one.
252256
- `avatar_url` - string - The user's avatar URL if they have set one.

0 commit comments

Comments
 (0)