matrix/authentication-service
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-authentication-service.git synced 2025-07-31 09:24:31 +03:00
Code Activity

Rework the docuemntation overview

Browse Source
This commit is contained in:
Quentin Gliech
2024-04-19 18:56:42 +02:00
parent 76e9c32642
commit 603de2b620
2 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.md
View File

@ -5,7 +5,13 @@ This documentation is intended to give an overview of how the `matrix-authentica
The documentation itself is built using [mdBook](https://rust-lang.github.io/mdBook/). The documentation itself is built using [mdBook](https://rust-lang.github.io/mdBook/).
A hosted version is available at <https://matrix-org.github.io/matrix-authentication-service/>. A hosted version is available at <https://matrix-org.github.io/matrix-authentication-service/>.
## Links ## How the documentation is organized
- Technical documentation for individual crates: [`rustdoc`](./rustdoc/mas_handlers/) This documentation has four main sections:
- UI components: [`storybook`](./storybook/)
- The [installation guide](./setup/README.md) will guide you through the process of setting up the `matrix-authentication-service` on your own infrastructure.
- The topics sections goes into more details about how the service works, like the [policy engine](./topics/policy.md) and how [authorization sessions](./topics/authorization.md) are managed.
- The reference documentation covers [configuration options](./reference/configuration.md), the [GraphQL API](./reference/graphql.md), the [scopes](./reference/scopes.md) supported by the service, and the [command line interface](./reference/cli/).
- The developer documentation is intended for people who want to [contribute to the project](./development/contributing.md). Other links:
- Technical documentation for individual crates: [`rustdoc`](./rustdoc/mas_handlers/)
- UI components: [`storybook`](./storybook/)

4
docs/reference/scopes.md
View File

@ -96,12 +96,14 @@ This allows the authenticated entity to perform any operation on the API, regard
The default policy doesn't allow everyone to request this scope. The default policy doesn't allow everyone to request this scope.
It allows: It allows:
- for the "authorization code" and "device authorization" grants: - for the "[authorization code]" and "[device authorization]" grants:
- users with the `can_request_admin` attribute set to `true` in the database - users with the `can_request_admin` attribute set to `true` in the database
- users listed in the [`policy.data.admin_users`](../reference/configuration.md#policy) configuration option - users listed in the [`policy.data.admin_users`](../reference/configuration.md#policy) configuration option
- for the "client credentials" grant: - for the "client credentials" grant:
- clients that are listed in the [`policy.data.admin_clients`](../reference/configuration.md#policy) configuration option - clients that are listed in the [`policy.data.admin_clients`](../reference/configuration.md#policy) configuration option
[authorization code]: ../topics/authorization.md#authorization-code-grant
[device authorization]: ../topics/authorization.md#device-authorization-grant
[GraphQL API]: ./graphql.md [GraphQL API]: ./graphql.md
[Synapse admin API]: https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html [Synapse admin API]: https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html
[OpenID Connect Core 1.0]: https://openid.net/specs/openid-connect-core-1_0.html [OpenID Connect Core 1.0]: https://openid.net/specs/openid-connect-core-1_0.html