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

Mention the configuration file reference in the SSO guide

Browse Source
This commit is contained in:
Quentin Gliech
2023-11-22 14:08:56 +01:00
parent 20fa1d516e
commit ef23b06261
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/setup/sso.md
View File

@ -13,6 +13,8 @@ A deployment which requires SAML or LDAP-based authentication should use a servi
Configuration of upstream providers is done in the `upstream_oauth2` section of the configuration file, which has a `providers` list.
This section needs to be synced with the database every time it changes, using the [`mas-cli config sync`](../usage/cli/config.md#config-sync---prune---dry-run) command.
**An exhaustive list of all the parameters is available in the [configuration file reference](../usage/configuration.md#upstream_oauth2).**
The general configuration usually goes as follows:
- determine a unique `id` for the provider, which will be used as stable identifier between the configuration file and the database. This `id` must be a ULID, and can be generated using online tools like <https://www.ulidtools.com>
@ -30,7 +32,6 @@ The general configuration usually goes as follows:
- `scope`: the scope to request from the provider. `openid` is usually required, and `profile` and `email` are recommended to import a few user attributes.
- setup user attributes mapping to automatically fill the user profile with data from the provider. See the [user attributes mapping](#user-attributes-mapping) section for more details.
## User attributes mapping
The authentication service supports importing the following user attributes from the provider: