Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
6dd7fa12
Unverified
Commit
6dd7fa12
authored
2 years ago
by
Dirk Klimpel
Committed by
GitHub
2 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Update some outdated information on `sso_mapping_providers.md` (#13449)
parent
afbdbe06
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
changelog.d/13449.doc
+1
-0
1 addition, 0 deletions
changelog.d/13449.doc
docs/sso_mapping_providers.md
+8
-6
8 additions, 6 deletions
docs/sso_mapping_providers.md
with
9 additions
and
6 deletions
changelog.d/13449.doc
0 → 100644
+
1
−
0
View file @
6dd7fa12
Update outdated information on `sso_mapping_providers` documentation.
This diff is collapsed.
Click to expand it.
docs/sso_mapping_providers.md
+
8
−
6
View file @
6dd7fa12
...
...
@@ -22,7 +22,7 @@ choose their own username.
In the first case - where users are automatically allocated a Matrix ID - it is
the responsibility of the mapping provider to normalise the SSO attributes and
map them to a valid Matrix ID. The
[
specification for Matrix
IDs
](
https://matrix.org/
docs/spec
/appendices#user-identifiers
)
has some
IDs
](
https://
spec.
matrix.org/
latest
/appendices
/
#user-identifiers
)
has some
information about what is considered valid.
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
## OpenID Mapping Providers
The OpenID mapping provider can be customized by editing the
`oidc_config.user_mapping_provider.module`
config option.
[
`oidc_providers.user_mapping_provider.module`
](
usage/configuration/config_documentation.md#oidc_providers
)
config option.
`oidc_
config
.user_mapping_provider.config`
allows you to provide custom
`oidc_
providers
.user_mapping_provider.config`
allows you to provide custom
configuration options to the module. Check with the module's documentation for
what options it provides (if any). The options listed by default are for the
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:
-
This method should have the
`@staticmethod`
decoration.
-
Arguments:
-
`config`
- A
`dict`
representing the parsed content of the
`oidc_
config
.user_mapping_provider.config`
homeserver config option.
`oidc_
providers
.user_mapping_provider.config`
homeserver config option.
Runs on homeserver startup. Providers should extract and validate
any option values they need here.
-
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:
will be returned as part of the response during a successful login.
Note that care should be taken to not overwrite any of the parameters
usually returned as part of the [login response](https://matrix.org/
docs/spec
/client
_
server
/latest
#post
-
matrix
-
client
-r0-
login).
usually returned as part of the [login response](https://
spec.
matrix.org/
latest
/client
-
server
-api/
#post
_
matrixclient
v3
login).
### Default OpenID Mapping Provider
...
...
@@ -113,7 +114,8 @@ specified in the config. It is located at
## SAML Mapping Providers
The SAML mapping provider can be customized by editing the
`saml2_config.user_mapping_provider.module`
config option.
[
`saml2_config.user_mapping_provider.module`
](
docs/usage/configuration/config_documentation.md#saml2_config
)
config option.
`saml2_config.user_mapping_provider.config`
allows you to provide custom
configuration options to the module. Check with the module's documentation for
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment