mirror of
https://github.com/element-hq/matrix-authentication-service.git
synced 2026-08-21 20:49:58 +00:00
Quentin Gliech
6094cc873d
Exposes a new query telling whether a given username is available for registration, and if not, why: already taken, or rejected by the registration policy. A username reserved on the homeserver side is deliberately reported as taken, mirroring the ambiguity of the registration form, which doesn't tell the two apart either. Because this effectively is a username-existence oracle, the query is rate-limited per requester, configurable through the new `rate_limiting.username_availability` option.
About this documentation
This documentation is intended to give an overview of how the matrix-authentication-service (MAS) works, both from an admin perspective and from a developer perspective.
MAS is an OAuth 2.0 and OpenID Provider server for Matrix. It has been created to support the migration of Matrix to an OpenID Connect (OIDC) based authentication layer as per MSC3861.
The documentation itself is built using mdBook. A hosted version is available at https://element-hq.github.io/matrix-authentication-service/.
How the documentation is organized
This documentation has four main sections:
- The installation guide will guide you through the process of setting up the
matrix-authentication-serviceon your own infrastructure. - The topics sections goes into more details about how the service works, like the policy engine and how authorization sessions are managed.
- The reference documentation covers configuration options, the Admin API, the scopes supported by the service, and the command line interface.
- The developer documentation is intended for people who want to contribute to the project. Developers may also be interested in: