OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix a buglet in the SAML username mapping provider doc (#8873) 

the constructor is called with a `module_api`.
pull/8879/head
Richard van der Hoff 2020-12-04 10:14:15 +00:00 committed by GitHub
parent cf3b8156be
commit 6e4f71c057
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/8873.doc Normal file
View File

@ -0,0 +1 @@
Fix an error in the documentation for the SAML username mapping provider.

4
docs/sso_mapping_providers.md
View File

@ -116,11 +116,13 @@ comment these options out and use those specified by the module instead.
A custom mapping provider must specify the following methods:
* `__init__(self, parsed_config)`
* `__init__(self, parsed_config, module_api)`
- Arguments:
- `parsed_config` - A configuration object that is the return value of the
`parse_config` method. You should set any configuration options needed by
the module here.
- `module_api` - a `synapse.module_api.ModuleApi` object which provides the
stable API available for extension modules.
* `parse_config(config)`
- This method should have the `@staticmethod` decoration.
- Arguments: