summary refs log tree commit diff
path: root/docs/admin_api/user_admin_api.md
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2024-05-13 12:12:54 +0100
committerErik Johnston <erik@matrix.org>2024-05-13 12:12:54 +0100
commit784c048aa407b163d825b0da5e6ea69fed9c995e (patch)
tree4a0ef50f84d9dbf76077588bc48fd1304a39e64a /docs/admin_api/user_admin_api.md
parentMerge remote-tracking branch 'origin/release-v1.107' into matrix-org-hotfixes (diff)
parentFix bug with creating public rooms on workers (#17177) (diff)
downloadsynapse-784c048aa407b163d825b0da5e6ea69fed9c995e.tar.xz
Merge remote-tracking branch 'origin/develop' into matrix-org-hotfixes
Diffstat (limited to 'docs/admin_api/user_admin_api.md')
-rw-r--r--docs/admin_api/user_admin_api.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md

index 9736fe3021..2281385830 100644 --- a/docs/admin_api/user_admin_api.md +++ b/docs/admin_api/user_admin_api.md
@@ -141,8 +141,8 @@ Body parameters: provider for SSO (Single sign-on). More details are in the configuration manual under the sections [sso](../usage/configuration/config_documentation.md#sso) and [oidc_providers](../usage/configuration/config_documentation.md#oidc_providers). - `auth_provider` - **string**, required. The unique, internal ID of the external identity provider. - The same as `idp_id` from the homeserver configuration. Note that no error is raised if the - provided value is not in the homeserver configuration. + The same as `idp_id` from the homeserver configuration. If using OIDC, this value should be prefixed + with `oidc-`. Note that no error is raised if the provided value is not in the homeserver configuration. - `external_id` - **string**, 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. - `admin` - **bool**, optional, defaults to `false`. Whether the user is a homeserver administrator,