From 74007ef5eee52d565048a68f870200c84a3e5721 Mon Sep 17 00:00:00 2001 From: richvdh Date: Wed, 7 Jul 2021 09:44:14 +0000 Subject: deploy: 7c823789921ac34f1fee670be7ef7f6c8266832b --- latest/admin_api/account_validity.html | 282 +++++++++++++++++++++++++++++++++ 1 file changed, 282 insertions(+) create mode 100644 latest/admin_api/account_validity.html (limited to 'latest/admin_api/account_validity.html') diff --git a/latest/admin_api/account_validity.html b/latest/admin_api/account_validity.html new file mode 100644 index 0000000000..51912c3300 --- /dev/null +++ b/latest/admin_api/account_validity.html @@ -0,0 +1,282 @@ + + + + + + Account Validity - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+ +
+ +
+ +

Account validity API

+

This API allows a server administrator to manage the validity of an account. To +use it, you must enable the account validity feature (under +account_validity) in Synapse's configuration.

+

Renew account

+

This API extends the validity of an account by as much time as configured in the +period parameter from the account_validity configuration.

+

The API is:

+
POST /_synapse/admin/v1/account_validity/validity
+
+

with the following body:

+
{
+    "user_id": "<user ID for the account to renew>",
+    "expiration_ts": 0,
+    "enable_renewal_emails": true
+}
+
+

expiration_ts is an optional parameter and overrides the expiration date, +which otherwise defaults to now + validity period.

+

enable_renewal_emails is also an optional parameter and enables/disables +sending renewal emails to the user. Defaults to true.

+

The API returns with the new expiration date for this account, as a timestamp in +milliseconds since epoch:

+
{
+    "expiration_ts": 0
+}
+
+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file -- cgit 1.5.1