diff options
author | reivilibre <reivilibre@users.noreply.github.com> | 2022-01-05 11:26:02 +0000 |
---|---|---|
committer | reivilibre <reivilibre@users.noreply.github.com> | 2022-01-05 11:26:02 +0000 |
commit | 82fa3e9e6f4affb7570a8470d9c810446ba810ec (patch) | |
tree | 7b06396bc09757a1ea7b49640867262e27547a76 /develop/sso_mapping_providers.html | |
parent | deploy: 0715e77b06ce4b73c3061562081b979b68440209 (diff) | |
download | synapse-82fa3e9e6f4affb7570a8470d9c810446ba810ec.tar.xz |
deploy: 84d790a32ec4641365adf494a21b28bd680faf38
Diffstat (limited to 'develop/sso_mapping_providers.html')
-rw-r--r-- | develop/sso_mapping_providers.html | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/develop/sso_mapping_providers.html b/develop/sso_mapping_providers.html index b9c3376041..fd6a0ca036 100644 --- a/develop/sso_mapping_providers.html +++ b/develop/sso_mapping_providers.html @@ -221,7 +221,7 @@ comment these options out and use those specified by the module instead.</p> <h3 id="building-a-custom-openid-mapping-provider"><a class="header" href="#building-a-custom-openid-mapping-provider">Building a Custom OpenID Mapping Provider</a></h3> <p>A custom mapping provider must specify the following methods:</p> <ul> -<li><code>__init__(self, parsed_config)</code> +<li><code>def __init__(self, parsed_config)</code> <ul> <li>Arguments: <ul> @@ -232,7 +232,7 @@ the module here.</li> </li> </ul> </li> -<li><code>parse_config(config)</code> +<li><code>def parse_config(config)</code> <ul> <li>This method should have the <code>@staticmethod</code> decoration.</li> <li>Arguments: @@ -247,7 +247,7 @@ any option values they need here.</li> <code>__init__</code> method during construction.</li> </ul> </li> -<li><code>get_remote_user_id(self, userinfo)</code> +<li><code>def get_remote_user_id(self, userinfo)</code> <ul> <li>Arguments: <ul> @@ -259,7 +259,7 @@ information from.</li> for the user. Commonly the <code>sub</code> claim of the response.</li> </ul> </li> -<li><code>map_user_attributes(self, userinfo, token, failures)</code> +<li><code>async def map_user_attributes(self, userinfo, token, failures)</code> <ul> <li>This method must be async.</li> <li>Arguments: @@ -290,7 +290,7 @@ remote user ID (see <code>get_remote_user_id</code>) it cannot be updated.</li> </li> </ul> </li> -<li><code>get_extra_attributes(self, userinfo, token)</code> +<li><code>async def get_extra_attributes(self, userinfo, token)</code> <ul> <li> <p>This method must be async.</p> @@ -328,7 +328,7 @@ comment these options out and use those specified by the module instead.</p> <h3 id="building-a-custom-saml-mapping-provider"><a class="header" href="#building-a-custom-saml-mapping-provider">Building a Custom SAML Mapping Provider</a></h3> <p>A custom mapping provider must specify the following methods:</p> <ul> -<li><code>__init__(self, parsed_config, module_api)</code> +<li><code>def __init__(self, parsed_config, module_api)</code> <ul> <li>Arguments: <ul> @@ -341,9 +341,9 @@ stable API available for extension modules.</li> </li> </ul> </li> -<li><code>parse_config(config)</code> +<li><code>def parse_config(config)</code> <ul> -<li>This method should have the <code>@staticmethod</code> decoration.</li> +<li><strong>This method should have the <code>@staticmethod</code> decoration.</strong></li> <li>Arguments: <ul> <li><code>config</code> - A <code>dict</code> representing the parsed content of the @@ -356,9 +356,9 @@ any option values they need here.</li> <code>__init__</code> method during construction.</li> </ul> </li> -<li><code>get_saml_attributes(config)</code> +<li><code>def get_saml_attributes(config)</code> <ul> -<li>This method should have the <code>@staticmethod</code> decoration.</li> +<li><strong>This method should have the <code>@staticmethod</code> decoration.</strong></li> <li>Arguments: <ul> <li><code>config</code> - A object resulting from a call to <code>parse_config</code>.</li> @@ -370,7 +370,7 @@ the second set consists of those attributes which can be used if available, but are not necessary.</li> </ul> </li> -<li><code>get_remote_user_id(self, saml_response, client_redirect_url)</code> +<li><code>def get_remote_user_id(self, saml_response, client_redirect_url)</code> <ul> <li>Arguments: <ul> @@ -384,7 +384,7 @@ redirected to.</li> for the user. Commonly the <code>uid</code> claim of the response.</li> </ul> </li> -<li><code>saml_response_to_user_attributes(self, saml_response, failures, client_redirect_url)</code> +<li><code>def saml_response_to_user_attributes(self, saml_response, failures, client_redirect_url)</code> <ul> <li> <p>Arguments:</p> |