diff options
Diffstat (limited to 'develop/admin_api/user_admin_api.html')
| -rw-r--r-- | develop/admin_api/user_admin_api.html | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html index 34ba483c4b..d399f21a7b 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/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> |