diff options
| author | Jacob Sánchez <jacobszpz@protonmail.com> | 2024-05-07 16:38:29 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-07 16:38:29 +0000 |
| commit | 1b155362cac535ace799df786ace3c53e816d042 (patch) | |
| tree | a616887fb025cc44d654491780328acca6788eec | |
| parent | Bump serde from 1.0.199 to 1.0.200 (#17161) (diff) | |
| download | synapse-1b155362cac535ace799df786ace3c53e816d042.tar.xz | |
Add note about external_ids for User Admin API in documentation (#17139)
| -rw-r--r-- | changelog.d/17139.doc | 1 | ||||
| -rw-r--r-- | docs/admin_api/user_admin_api.md | 4 |
2 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/17139.doc b/changelog.d/17139.doc new file mode 100644 index 0000000000..a6d5408cac --- /dev/null +++ b/changelog.d/17139.doc @@ -0,0 +1 @@ +Update User Admin API with note about prefixing OIDC external_id providers. 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, |