Skip to content
Snippets Groups Projects
Unverified Commit 1b155362 authored by Jacob Sánchez's avatar Jacob Sánchez Committed by GitHub
Browse files

Add note about external_ids for User Admin API in documentation (#17139)

parent 438bc235
Branches
Tags
No related merge requests found
Update User Admin API with note about prefixing OIDC external_id providers.
...@@ -141,8 +141,8 @@ Body parameters: ...@@ -141,8 +141,8 @@ Body parameters:
provider for SSO (Single sign-on). More details are in the configuration manual under the 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). 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. - `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 The same as `idp_id` from the homeserver configuration. If using OIDC, this value should be prefixed
provided value is not in the homeserver configuration. 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. - `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. 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, - `admin` - **bool**, optional, defaults to `false`. Whether the user is a homeserver administrator,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment