From 4199abcaf06b8dad7662a11fd3ddc1f17d3ef87c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacob=20S=C3=A1nchez?= Date: Wed, 1 May 2024 09:48:06 +0000 Subject: [PATCH 1/3] Add note about external_ids for User Admin API in documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jacob Sánchez --- docs/admin_api/user_admin_api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md index 9736fe30214..22813858301 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, From 7d39e1d562625f73e6c4a9b3da62e1c7dfb2b2ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacob=20S=C3=A1nchez?= Date: Wed, 1 May 2024 09:57:06 +0000 Subject: [PATCH 2/3] Newsfile --- changelog.d/17139.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/17139.doc diff --git a/changelog.d/17139.doc b/changelog.d/17139.doc new file mode 100644 index 00000000000..78864e1e675 --- /dev/null +++ b/changelog.d/17139.doc @@ -0,0 +1 @@ +Update User Admin API with note about prefixing OIDC external_id providers From 71b53758ab0594a5850cebc87c653c5ac5a0f12b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacob=20S=C3=A1nchez?= Date: Thu, 2 May 2024 08:00:24 +0000 Subject: [PATCH 3/3] Update 17139.doc --- changelog.d/17139.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/17139.doc b/changelog.d/17139.doc index 78864e1e675..a6d5408cac3 100644 --- a/changelog.d/17139.doc +++ b/changelog.d/17139.doc @@ -1 +1 @@ -Update User Admin API with note about prefixing OIDC external_id providers +Update User Admin API with note about prefixing OIDC external_id providers.