From 032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Mon, 24 Oct 2022 14:05:50 +0100 Subject: Rearrange admin API fs heirarchy to match sidebar I've kept the RST redirect file in-place though --- docs/admin_api/account_validity.md | 45 -------------------------------------- 1 file changed, 45 deletions(-) delete mode 100644 docs/admin_api/account_validity.md (limited to 'docs/admin_api/account_validity.md') diff --git a/docs/admin_api/account_validity.md b/docs/admin_api/account_validity.md deleted file mode 100644 index d878bf7451..0000000000 --- a/docs/admin_api/account_validity.md +++ /dev/null @@ -1,45 +0,0 @@ -# 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. - -To use it, you will need to authenticate by providing an `access_token` -for a server admin: see [Admin API](../usage/administration/admin_api). - -## 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: - -```json -{ - "user_id": "", - "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: - -```json -{ - "expiration_ts": 0 -} -``` -- cgit 1.5.1