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

Use the right path for the identity API

Browse source
This commit is contained in:
David Baker 2016-10-07 18:17:45 +01:00
parent 42616f839c
commit 49ee00c361
3 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api/identity/lookup.yaml
View file

@ -19,7 +19,7 @@ host: localhost:8090
schemes: schemes:
- https - https
- http - http
basePath: /_matrix/identity/v1/api basePath: /_matrix/identity/api/v1
produces: produces:
- application/json - application/json
paths: paths:

2
api/identity/pubkey.yaml
View file

@ -19,7 +19,7 @@ host: localhost:8090
schemes: schemes:
- https - https
- http - http
basePath: /_matrix/identity/v1/api basePath: /_matrix/identity/api/v1
produces: produces:
- application/json - application/json
paths: paths:

10
specification/identity_service_api.rst
View file

@ -110,7 +110,7 @@ Creating a session
A client makes a call to:: A client makes a call to::
POST https://my.id.server:8090/_matrix/identity/v1/api/validate/email/requestToken POST https://my.id.server:8090/_matrix/identity/api/v1/validate/email/requestToken
client_secret=monkeys_are_GREAT& client_secret=monkeys_are_GREAT&
email=foo@bar.com& email=foo@bar.com&
@ -147,7 +147,7 @@ Validating ownership of an email
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A user may make either a ``GET`` or a ``POST`` request to A user may make either a ``GET`` or a ``POST`` request to
``/_matrix/identity/v1/api/validate/email/submitToken`` with the following ``/_matrix/identity/api/v1/validate/email/submitToken`` with the following
parameters (either as query parameters or URL-encoded POST parameters): parameters (either as query parameters or URL-encoded POST parameters):
- ``sid`` the sid for the session, generated by the ``requestToken`` call. - ``sid`` the sid for the session, generated by the ``requestToken`` call.
- ``client_secret`` the client secret which was supplied to the ``requestToken`` call. - ``client_secret`` the client secret which was supplied to the ``requestToken`` call.
@ -164,7 +164,7 @@ Checking non-published 3pid ownership
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A client can check whether ownership of a 3pid was validated by making an A client can check whether ownership of a 3pid was validated by making an
HTTP GET request to ``/_matrix/identity/v1/api/3pid/getValidated3pid``, passing HTTP GET request to ``/_matrix/identity/api/v1/3pid/getValidated3pid``, passing
the ``sid`` and ``client_secret`` as query parameters from the ``requestToken`` the ``sid`` and ``client_secret`` as query parameters from the ``requestToken``
call. call.
@ -183,7 +183,7 @@ Publishing a validated association
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
An association between a session and a Matrix user ID can be published by making An association between a session and a Matrix user ID can be published by making
a URL-encoded HTTP POST request to ``/_matrix/identity/v1/api/3pid/bind`` with a URL-encoded HTTP POST request to ``/_matrix/identity/api/v1/3pid/bind`` with
the following parameters:: the following parameters::
sid=sid& sid=sid&
@ -256,7 +256,7 @@ At a later point, if the owner of that particular 3pid binds it with a Matrix us
Where the signature is produced using a long-term private key. Where the signature is produced using a long-term private key.
Also, the generated ephemeral public key will be listed as valid on requests to ``/_matrix/identity/v1/api/pubkey/ephemeral/isvalid``. Also, the generated ephemeral public key will be listed as valid on requests to ``/_matrix/identity/api/v1/pubkey/ephemeral/isvalid``.
Ephemeral invitation signing Ephemeral invitation signing
---------------------------- ----------------------------