wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add requestToken endpoints

Browse source 
For password reset and 3pid adding
This commit is contained in:
David Baker 2016-07-07 14:52:45 +01:00
parent ef4c03894d
commit ead5648b8c
3 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
api/client-server/administrative_contact.yaml
View file

@ -119,3 +119,12 @@ paths:
} }
tags: tags:
- User data - User data
"/account/3pid/email/requestToken":
post:
summary: Requests a validation token be sent to the given email address
description: |-
Proxies the identity server API ``validate/email/requestToken``, but
first checks that the given email address is not already associated
with an account on this Home Server. This API should be used to request
validation tokens when adding an email address to an account. This API
behaves identically to `/register/email/requestToken`

13
api/client-server/registration.yaml
View file

@ -242,3 +242,16 @@ paths:
"$ref": "definitions/error.yaml" "$ref": "definitions/error.yaml"
tags: tags:
- User data - User data
"/account/password/email/requestToken":
post:
summary: Requests a validation token be sent to the given email address
description: |-
Proxies the identity server API ``validate/email/requestToken``, but
first checks that the given email address is associated with an account
on this Home Server. This API should be used to request
validation tokens when authenticating for the
`account/password` endpoint. This API behaves identically to
`/register/email/requestToken` except that `M_THREEPID_NOT_FOUND` may be
returned if no account matching the given email address could be found.
The server may instead send an email to the given address prompting
the user to create an account. `M_THREEPID_IN_USE` may not be returned.

3
specification/client_server_api.rst
View file

@ -116,6 +116,9 @@ Some requests have unique error codes:
:``M_THREEPID_IN_USE``: :``M_THREEPID_IN_USE``:
Sent when a threepid given to an API cannot be used because the same threepid is already in use. Sent when a threepid given to an API cannot be used because the same threepid is already in use.
:``M_THREEPID_NOT_FOUND``:
Sent when a threepid given to an API cannot be used because no record matching the threepid was found
:``M_SERVER_NOT_TRUSTED``: :``M_SERVER_NOT_TRUSTED``:
The client's request used a third party server, eg. ID server, that this server does not trust. The client's request used a third party server, eg. ID server, that this server does not trust.