3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update the delete user documentation 

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2021-05-14 12:38:02 -04:00
parent e73f9b7bf5
commit 158f92f17f
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/web_api.md
View File

@ -1613,7 +1613,12 @@ logs the user in.
or be logged in as another user. or be logged in as another user.
#### Delete User #### Delete User
Deletes the currently logged in user. Deletes a registered user.
!!! note
A request to delete a user MUST come from an authorized source
other than the account to be deleted. This can be a "trusted user",
the "api key user", or any other user account.
HTTP Request: HTTP Request:
```http ```http
@ -1621,13 +1626,13 @@ DELETE /access/user
Content-Type: application/json Content-Type: application/json
{ {
"password": "my_password" "username": "my_username"
} }
``` ```
JSON-RPC request: Not Available JSON-RPC request: Not Available
Returns: The username of the deleted user and an action summary. This Returns: The username of the deleted user and an action summary. This
effectively logs the user out. effectively logs the user out, as all outstanding tokens will be invalid.
```json ```json
{ {
"username": "my_user", "username": "my_user",