summary refs log tree commit diff
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2020-12-04 10:14:15 +0000
committerGitHub <noreply@github.com>2020-12-04 10:14:15 +0000
commit6e4f71c0574adf9bb314982713c38b1c0064d293 (patch)
treec6cbed34915c3e1ae8eb90ac816bf90d7776b045
parentFix errorcode for disabled registration (#8867) (diff)
downloadsynapse-6e4f71c0574adf9bb314982713c38b1c0064d293.tar.xz
Fix a buglet in the SAML username mapping provider doc (#8873)
the constructor is called with a `module_api`.
Diffstat (limited to '')
-rw-r--r--changelog.d/8873.doc1
-rw-r--r--docs/sso_mapping_providers.md4
2 files changed, 4 insertions, 1 deletions
diff --git a/changelog.d/8873.doc b/changelog.d/8873.doc
new file mode 100644
index 0000000000..0c2a043bd1
--- /dev/null
+++ b/changelog.d/8873.doc
@@ -0,0 +1 @@
+Fix an error in the documentation for the SAML username mapping provider.
diff --git a/docs/sso_mapping_providers.md b/docs/sso_mapping_providers.md
index dee53b5d40..c13b4f7155 100644
--- a/docs/sso_mapping_providers.md
+++ b/docs/sso_mapping_providers.md
@@ -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: