summary refs log tree commit diff
path: root/latest/admin_api/user_admin_api.html
diff options
context:
space:
mode:
authorreivilibre <reivilibre@users.noreply.github.com>2024-05-28 12:35:50 +0000
committerreivilibre <reivilibre@users.noreply.github.com>2024-05-28 12:35:50 +0000
commit51a8c6b121e2e639a0d818ff36e5bb82c98bd89b (patch)
tree5ba460bd7cf47ed301c707b532e08f59c4d1409d /latest/admin_api/user_admin_api.html
parentdeploy: 5147ce294a5653166e6238b2e304b81c13d343a1 (diff)
downloadsynapse-51a8c6b121e2e639a0d818ff36e5bb82c98bd89b.tar.xz
deploy: f35bc08d3933416d2c7a0c566f895214e9ffd88e
Diffstat (limited to 'latest/admin_api/user_admin_api.html')
-rw-r--r--latest/admin_api/user_admin_api.html4
1 files changed, 2 insertions, 2 deletions
diff --git a/latest/admin_api/user_admin_api.html b/latest/admin_api/user_admin_api.html

index 34ba483c4b..d399f21a7b 100644 --- a/latest/admin_api/user_admin_api.html +++ b/latest/admin_api/user_admin_api.html
@@ -299,8 +299,8 @@ provider for SSO (Single sign-on). More details are in the configuration manual sections <a href="../usage/configuration/config_documentation.html#sso">sso</a> and <a href="../usage/configuration/config_documentation.html#oidc_providers">oidc_providers</a>.</p> <ul> <li><code>auth_provider</code> - <strong>string</strong>, required. The unique, internal ID of the external identity provider. -The same as <code>idp_id</code> from the homeserver configuration. Note that no error is raised if the -provided value is not in the homeserver configuration.</li> +The same as <code>idp_id</code> from the homeserver configuration. If using OIDC, this value should be prefixed +with <code>oidc-</code>. Note that no error is raised if the provided value is not in the homeserver configuration.</li> <li><code>external_id</code> - <strong>string</strong>, required. An identifier for the user in the external identity provider. When the user logs in to the identity provider, this must be the unique ID that they map to.</li> </ul>