summary refs log tree commit diff
diff options
context:
space:
mode:
authorWill Hunt <will@half-shot.uk>2023-07-14 13:32:13 +0100
committerGitHub <noreply@github.com>2023-07-14 08:32:13 -0400
commit8d3656b994173b899ce2be18a2600273aa4e7d32 (patch)
tree0f47e4f2083b66b2691dce0e347677b9fec4583f
parentStop accepting 'user' parameter for application service registration. (#15928) (diff)
downloadsynapse-8d3656b994173b899ce2be18a2600273aa4e7d32.tar.xz
Document that you cannot login as yourself on /_synapse/admin/v1/users/<user_id>/login (#15938)
-rw-r--r--changelog.d/15938.doc1
-rw-r--r--docs/admin_api/user_admin_api.md3
2 files changed, 3 insertions, 1 deletions
diff --git a/changelog.d/15938.doc b/changelog.d/15938.doc
new file mode 100644
index 0000000000..8d99e5f4ea
--- /dev/null
+++ b/changelog.d/15938.doc
@@ -0,0 +1 @@
+Improve the documentation for the login as a user admin API.
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index 23f465e98d..ac4f635099 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/docs/admin_api/user_admin_api.md
@@ -732,7 +732,8 @@ POST /_synapse/admin/v1/users/<user_id>/login
 
 An optional `valid_until_ms` field can be specified in the request body as an
 integer timestamp that specifies when the token should expire. By default tokens
-do not expire.
+do not expire. Note that this API does not allow a user to login as themselves
+(to create more tokens).
 
 A response body like the following is returned: