Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-31 16:24:10 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update wording and add deactivate account API

Browse source
This commit is contained in:
Erik Johnston 2019-03-12 14:20:37 +00:00
parent 77110b46df
commit 60f1cf79de
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
proposals/1915-unbind-identity-server-param.md
View file

@ -13,16 +13,16 @@ This is meant as a simple extension to the current APIs, and so this explicitly
does not try and solve any existing usability concerns. does not try and solve any existing usability concerns.
## New APIs ## API Changes
### Client-Server API ### Client-Server 3PID Delete API
Add `POST /_matrix/client/r0/account/3pid/delete` API, which expects a JSON body Add an `id_server` param to `POST /_matrix/client/r0/account/3pid/delete` API,
with `medium`, `address` and `id_server` fields (as per existing APIs). which matches the 3PID creation APIs.
The `id_server` parameter is optional and if missing the server will attempt to The new `id_server` parameter is optional and if missing the server will attempt
unbind from a suitable identity server (e.g. its default identity server or the to unbind from a suitable identity server (e.g. its default identity server or
server used when originally binding the 3pid). the server used when originally binding the 3pid).
The 200 response is a JSON object with an `id_server_unbind_result` field whose The 200 response is a JSON object with an `id_server_unbind_result` field whose
value is either `success` or `no-support`, where the latter indicates that the value is either `success` or `no-support`, where the latter indicates that the
@ -45,8 +45,14 @@ HTTP/1.1 200 OK
} }
``` ```
### Client-Server Deactivate account API
### Identity Server API Add an `id_server` param to `POST /_matrix/client/r0/account/deactivate` API,
with the same semantics as above. This is used to unbind any bound threepids
from the given identity server.
### Identity Server 3PID Unbind API
Add `POST /_matrix/identity/api/v1/unbind` with `mxid` and `threepid` fields. Add `POST /_matrix/identity/api/v1/unbind` with `mxid` and `threepid` fields.
The `mxid` is the user's `user_id` and `threepid` is a dict with the usual The `mxid` is the user's `user_id` and `threepid` is a dict with the usual