Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Clean up and clarify "Create or modify Account" Admin API documentation #15544

Merged
merged 13 commits into from
May 5, 2023
Prev Previous commit
Next Next commit
Clarify 'admin'
  • Loading branch information
anoadragon453 committed May 5, 2023
commit 32580f6e8747de79be2156073d8d3320a213b1d1
3 changes: 2 additions & 1 deletion docs/admin_api/user_admin_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,8 @@ Body parameters:
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`.
- `admin` - bool, optional, defaults to `false`. Whether the user is a homeserver administrator,
granting them access to the Admin API, among other things.
- `deactivated` - bool, optional. If unspecified, deactivation state will be left
unchanged on existing accounts and set to `false` for new accounts.
A user cannot be erased by deactivating with this API. For details on
Expand Down