lda/telodendria
lda
/
telodendria
forked from Telodendria/Telodendria
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
telodendria/docs/user/admin
History
Jordan Bancino 2d30719be4 Implement Registration Token Administrator API (#43) 
This pull request fully implements and documents all of the registration token administrator API endpoints.

**NOTE:** There is a memory leak when listing all of the registration tokens. Debug this before merging.
 
~~Closes~~ Supersedes #37.

Closes #26.

This pull request is based off of #37, which addresses #26. This pull makes a number of improvements to the logic, organization, and behavior of the API endpoints.

Co-authored-by: hatkid <daichi93100@gmail.com>
Co-authored-by: LoaD Accumulator <lda@freetards.xyz>
Co-authored-by: LoaD Accumulator <lda@noreply.git.telodendria.io>
Co-authored-by: lda <lda@freetards.xyz>
Co-authored-by: Load Accumulator <lda@freetards.xyz>
Reviewed-on: Telodendria/Telodendria#43
 		2023-11-10 09:30:53 -05:00
..
README.md Implement Registration Token Administrator API (#43) 2023-11-10 09:30:53 -05:00
config.md Fix admin endpoint names in documentation 2023-11-08 11:21:20 -05:00
privileges.md Fix admin endpoint names in documentation 2023-11-08 11:21:20 -05:00
proc.md Fix admin endpoint names in documentation 2023-11-08 11:21:20 -05:00
stats.md Fix admin endpoint names in documentation 2023-11-08 11:21:20 -05:00
tokens.md Implement Registration Token Administrator API (#43) 2023-11-10 09:30:53 -05:00

README.md

Administrator API

Telodendria provides an administrator API as an extension to the Matrix specification that allows for administrator control over the homeserver. This includes profiling and examining the state of running instances, as well as managing users and media.

Like Synapse, Telodendria supports designating specific local users as administrators. However, unlike Synapse, Telodendria uses a more fine-grained privilege model that allows a server administrator to delegate specific administration tasks to other users while not compromising and granting them full administrative access to the server.

To authenticate with the administrator API, simply use your login access token just like you would authenticate any other Matrix client request.

API Conventions

Unless otherwise indicated, HTTP response codes that are not 200 Ok will be accompanied by a standard Matrix API error. Consult the Matrix specification for the format of these errors. The following error conditions are assumed to be possible for all API endpoints listed in the Administrator API documentation:

Response Code Description
400 The user is not authenticated, did not provide a valid JSON object, or provided a JSON object with invalid or missing parameters.
403 The user does not have the privileges necessary to carry out the requested action.
500 A fatal server error occurred. Check the logs for more information.