Skip to content

Commit 1b15536

Browse files
authored
Add note about external_ids for User Admin API in documentation (#17139)
1 parent 438bc23 commit 1b15536

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

changelog.d/17139.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update User Admin API with note about prefixing OIDC external_id providers.

docs/admin_api/user_admin_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ Body parameters:
141141
provider for SSO (Single sign-on). More details are in the configuration manual under the
142142
sections [sso](../usage/configuration/config_documentation.md#sso) and [oidc_providers](../usage/configuration/config_documentation.md#oidc_providers).
143143
- `auth_provider` - **string**, required. The unique, internal ID of the external identity provider.
144-
The same as `idp_id` from the homeserver configuration. Note that no error is raised if the
145-
provided value is not in the homeserver configuration.
144+
The same as `idp_id` from the homeserver configuration. If using OIDC, this value should be prefixed
145+
with `oidc-`. Note that no error is raised if the provided value is not in the homeserver configuration.
146146
- `external_id` - **string**, required. An identifier for the user in the external identity provider.
147147
When the user logs in to the identity provider, this must be the unique ID that they map to.
148148
- `admin` - **bool**, optional, defaults to `false`. Whether the user is a homeserver administrator,

0 commit comments

Comments
 (0)