Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 6dd7fa1

Browse files
authored
Update some outdated information on sso_mapping_providers.md (#13449)
1 parent afbdbe0 commit 6dd7fa1

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

changelog.d/13449.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update outdated information on `sso_mapping_providers` documentation.

docs/sso_mapping_providers.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ choose their own username.
2222
In the first case - where users are automatically allocated a Matrix ID - it is
2323
the responsibility of the mapping provider to normalise the SSO attributes and
2424
map them to a valid Matrix ID. The [specification for Matrix
25-
IDs](https://matrix.org/docs/spec/appendices#user-identifiers) has some
25+
IDs](https://spec.matrix.org/latest/appendices/#user-identifiers) has some
2626
information about what is considered valid.
2727

2828
If the mapping provider does not assign a Matrix ID, then Synapse will
@@ -37,9 +37,10 @@ as Synapse). The Synapse config is then modified to point to the mapping provide
3737
## OpenID Mapping Providers
3838

3939
The OpenID mapping provider can be customized by editing the
40-
`oidc_config.user_mapping_provider.module` config option.
40+
[`oidc_providers.user_mapping_provider.module`](usage/configuration/config_documentation.md#oidc_providers)
41+
config option.
4142

42-
`oidc_config.user_mapping_provider.config` allows you to provide custom
43+
`oidc_providers.user_mapping_provider.config` allows you to provide custom
4344
configuration options to the module. Check with the module's documentation for
4445
what options it provides (if any). The options listed by default are for the
4546
user mapping provider built in to Synapse. If using a custom module, you should
@@ -58,7 +59,7 @@ A custom mapping provider must specify the following methods:
5859
- This method should have the `@staticmethod` decoration.
5960
- Arguments:
6061
- `config` - A `dict` representing the parsed content of the
61-
`oidc_config.user_mapping_provider.config` homeserver config option.
62+
`oidc_providers.user_mapping_provider.config` homeserver config option.
6263
Runs on homeserver startup. Providers should extract and validate
6364
any option values they need here.
6465
- Whatever is returned will be passed back to the user mapping provider module's
@@ -102,7 +103,7 @@ A custom mapping provider must specify the following methods:
102103
will be returned as part of the response during a successful login.
103104

104105
Note that care should be taken to not overwrite any of the parameters
105-
usually returned as part of the [login response](https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-login).
106+
usually returned as part of the [login response](https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3login).
106107

107108
### Default OpenID Mapping Provider
108109

@@ -113,7 +114,8 @@ specified in the config. It is located at
113114
## SAML Mapping Providers
114115

115116
The SAML mapping provider can be customized by editing the
116-
`saml2_config.user_mapping_provider.module` config option.
117+
[`saml2_config.user_mapping_provider.module`](docs/usage/configuration/config_documentation.md#saml2_config)
118+
config option.
117119

118120
`saml2_config.user_mapping_provider.config` allows you to provide custom
119121
configuration options to the module. Check with the module's documentation for

0 commit comments

Comments
 (0)