diff options
| author | clokep <clokep@users.noreply.github.com> | 2023-08-11 20:16:17 +0000 |
|---|---|---|
| committer | clokep <clokep@users.noreply.github.com> | 2023-08-11 20:16:17 +0000 |
| commit | 112a3c66031c57f91fd27ea9d8d445f4a30c84cf (patch) | |
| tree | 46c9a04e1e3a7afe513c38ae5b680e845b77e3f3 /develop/usage | |
| parent | deploy: dac97642e41f3f4bc0deff0c80b6a3f7acb4dbc0 (diff) | |
| download | synapse-112a3c66031c57f91fd27ea9d8d445f4a30c84cf.tar.xz | |
deploy: 9ff84bccbb152460913d63d4b8e9dffc220adfea
Diffstat (limited to 'develop/usage')
| -rw-r--r-- | develop/usage/configuration/config_documentation.html | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html index 819e971d20..3c211704e4 100644 --- a/develop/usage/configuration/config_documentation.html +++ b/develop/usage/configuration/config_documentation.html @@ -2640,6 +2640,16 @@ enable SAML login. You can either put your entire pysaml config inline using the option, or you can specify a path to a psyaml config file with the sub-option <code>config_path</code>. This setting has the following sub-options:</p> <ul> +<li><code>idp_name</code>: A user-facing name for this identity provider, which is used to +offer the user a choice of login mechanisms.</li> +<li><code>idp_icon</code>: An optional icon for this identity provider, which is presented +by clients and Synapse's own IdP picker page. If given, must be an +MXC URI of the format <code>mxc://<server-name>/<media-id></code>. (An easy way to +obtain such an MXC URI is to upload an image to an (unencrypted) room +and then copy the "url" from the source of the event.)</li> +<li><code>idp_brand</code>: An optional brand for this identity provider, allowing clients +to style the login flow according to the identity provider in question. +See the <a href="https://spec.matrix.org/latest/">spec</a> for possible options here.</li> <li><code>sp_config</code>: the configuration for the pysaml2 Service Provider. See pysaml2 docs for format of config. Default values will be used for the <code>entityid</code> and <code>service</code> settings, so it is not normally necessary to specify them unless you need to @@ -2798,7 +2808,7 @@ offer the user a choice of login mechanisms.</p> <li> <p><code>idp_icon</code>: An optional icon for this identity provider, which is presented by clients and Synapse's own IdP picker page. If given, must be an -MXC URI of the format mxc://<server-name>/<media-id>. (An easy way to +MXC URI of the format <code>mxc://<server-name>/<media-id></code>. (An easy way to obtain such an MXC URI is to upload an image to an (unencrypted) room and then copy the "url" from the source of the event.)</p> </li> @@ -3042,6 +3052,16 @@ Has the following sub-options:</p> <ul> <li><code>enabled</code>: Set this to true to enable authorization against a CAS server. Defaults to false.</li> +<li><code>idp_name</code>: A user-facing name for this identity provider, which is used to +offer the user a choice of login mechanisms.</li> +<li><code>idp_icon</code>: An optional icon for this identity provider, which is presented +by clients and Synapse's own IdP picker page. If given, must be an +MXC URI of the format <code>mxc://<server-name>/<media-id></code>. (An easy way to +obtain such an MXC URI is to upload an image to an (unencrypted) room +and then copy the "url" from the source of the event.)</li> +<li><code>idp_brand</code>: An optional brand for this identity provider, allowing clients +to style the login flow according to the identity provider in question. +See the <a href="https://spec.matrix.org/latest/">spec</a> for possible options here.</li> <li><code>server_url</code>: The URL of the CAS authorization endpoint.</li> <li><code>displayname_attribute</code>: The attribute of the CAS response to use as the display name. If no name is given here, no displayname will be set.</li> |