summary refs log tree commit diff
path: root/docs/administration/admin_api/account_validity.md
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2022-10-24 14:05:50 +0100
committerDavid Robertson <davidr@element.io>2022-10-24 14:12:58 +0100
commit032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0 (patch)
tree2e513b6fddf3f8a1b4f285d38d3fd12fa820599b /docs/administration/admin_api/account_validity.md
parentMove admin docs to admin section (excluding admin api) (diff)
downloadsynapse-032dafe232f4e2c93b92c83b51c3c1c3dfe30bf0.tar.xz
Rearrange admin API fs heirarchy to match sidebar
I've kept the RST redirect file in-place though
Diffstat (limited to 'docs/administration/admin_api/account_validity.md')
-rw-r--r--docs/administration/admin_api/account_validity.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/administration/admin_api/account_validity.md b/docs/administration/admin_api/account_validity.md
new file mode 100644

index 0000000000..d878bf7451 --- /dev/null +++ b/docs/administration/admin_api/account_validity.md
@@ -0,0 +1,45 @@ +# 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": "<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: + +```json +{ + "expiration_ts": 0 +} +```