diff options
| author | Mathieu Velten <matmaul@gmail.com> | 2024-03-19 18:20:10 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-19 17:20:10 +0000 |
| commit | 74ab329eaa50348d3ff65fc97d7fbc9cd9773311 (patch) | |
| tree | f54f66631c011296b5ff2d745d02058a25bca72a /docs | |
| parent | Specify IP subnet literals in canonical form (#16953) (diff) | |
| download | synapse-74ab329eaa50348d3ff65fc97d7fbc9cd9773311.tar.xz | |
Pass module API to OIDC mapping provider (#16974)
As done for SAML mapping provider, let's pass the module API to the OIDC one so the mapper can do more logic in its code.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sso_mapping_providers.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/sso_mapping_providers.md b/docs/sso_mapping_providers.md index 77cc02c541..10c695029f 100644 --- a/docs/sso_mapping_providers.md +++ b/docs/sso_mapping_providers.md @@ -50,11 +50,13 @@ comment these options out and use those specified by the module instead. A custom mapping provider must specify the following methods: -* `def __init__(self, parsed_config)` +* `def __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. * `def parse_config(config)` - This method should have the `@staticmethod` decoration. - Arguments: |