dendrite/docs/administration/4_adminapi.md

title	parent	permalink
Supported admin APIs	Administration	/administration/adminapi

Supported admin APIs

Dendrite supports, at present, a very small number of endpoints that allow admin users to perform administrative functions. Please note that there is no API stability guarantee on these endpoints at present — they may change shape without warning.

More endpoints will be added in the future.

Endpoints may be used directly through curl.:

curl --header "Authorization: Bearer <access_token>" -X <POST|GET|PUT> <Endpoint URI> -d '<Request Body Content>'

GET /_dendrite/admin/evacuateRoom/{roomID}

This endpoint will instruct Dendrite to part all local users from the given roomID in the URL. It may take some time to complete. A JSON body will be returned containing the user IDs of all affected users.

GET /_dendrite/admin/evacuateUser/{userID}

This endpoint will instruct Dendrite to part the given local userID in the URL from all rooms which they are currently joined. A JSON body will be returned containing the room IDs of all affected rooms.

POST /_dendrite/admin/resetPassword/{localpart}

Request body format:

{
    "password": "new_password_here"
}

Reset the password of a local user. The localpart is the username only, i.e. if the full user ID is @alice:domain.com then the local part is alice.

POST /_synapse/admin/v1/send_server_notice

Request body format:

    {
        "user_id": "@target_user:server_name",
        "content": {
           "msgtype": "m.text",
           "body": "This is my message"
        }
    }

Send a server notice to a specific user. If successfully sent, the API will return the following response:

   {
        "event_id": "<event_id>"
   }

GET /_synapse/admin/v1/register

Shared secret registration — please see the user creation page for guidance on configuring and using this endpoint.

GET /_matrix/client/v3/admin/whois/{userId}

From the Matrix Spec. Gets information about a particular user. userId is the full user ID e.g. @alice:domain.com