summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorRobin Vleij <robin@vleij.com>2020-02-05 22:27:38 +0100
committerGitHub <noreply@github.com>2020-02-05 21:27:38 +0000
commitf0561fcffd172cb0dfe035dcc78f51bdd451c010 (patch)
tree493c748ab9569c080d9e71cb87320c63f19d116d /docs/admin_api
parent1.9.1 (diff)
downloadsynapse-f0561fcffd172cb0dfe035dcc78f51bdd451c010.tar.xz
Update documentation (#6859)
Update documentation to reflect the correct format of user_id (fully qualified).
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/user_admin_api.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst
index 0b3d09d694..ed6df61a26 100644
--- a/docs/admin_api/user_admin_api.rst
+++ b/docs/admin_api/user_admin_api.rst
@@ -2,7 +2,8 @@ Create or modify Account
 ========================
 
 This API allows an administrator to create or modify a user account with a
-specific ``user_id``.
+specific ``user_id``. Be aware that ``user_id`` is fully qualified: for example,
+``@user:server.com``.
 
 This api is::