Admin API

This document describes the Arminius Admin API and how to authenticate against it.

Overview

The Arminius Admin API provides additional functionality for server administrators. It is a complement to the Matrix APIs, providing ergonomic management of rooms, users, and other server properties.

Authentication

The Admin API authenticates requests with the Matrix access token from the user’s OpenID Connect (OIDC) session.

Warning

Arminius does not yet check authorization. Any user with an active session is a server admin. Do not expose the Admin API publicly. See FIXME(#2215).

API Documentation

The API documentation is available in the form of an OpenAPI specification.