diff options
| author | Erik Johnston <erik@matrix.org> | 2014-08-15 11:50:14 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2014-08-15 11:50:14 +0100 |
| commit | d72f897f078fa72548522440149369293f0d12b2 (patch) | |
| tree | 4e8d692713f73389b89dea4fdba719b696c9f3af /docs/client-server/specification.rst | |
| parent | Reimplement the get public rooms api to work with new DB schema (diff) | |
| parent | Add a check to make sure that during state conflict res we only request a PDU... (diff) | |
| download | synapse-d72f897f078fa72548522440149369293f0d12b2.tar.xz | |
Merge branch 'master' of github.com:matrix-org/synapse into sql_refactor
Conflicts: synapse/storage/stream.py
Diffstat (limited to 'docs/client-server/specification.rst')
| -rw-r--r-- | docs/client-server/specification.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/client-server/specification.rst b/docs/client-server/specification.rst index 7df2bb14c5..3367884ad4 100644 --- a/docs/client-server/specification.rst +++ b/docs/client-server/specification.rst @@ -1,6 +1,6 @@ -========================= -Synapse Client-Server API -========================= +======================== +Matrix Client-Server API +======================== The following specification outlines how a client can send and receive data from a home server. @@ -262,7 +262,10 @@ the error, but the keys 'error' and 'errcode' will always be present. Some standard error codes are below: M_FORBIDDEN: -Forbidden access, e.g. bad access token, failed login. +Forbidden access, e.g. joining a room without permission, failed login. + +M_UNKNOWN_TOKEN: +The access token specified was not recognised. M_BAD_JSON: Request contained valid JSON, but it was malformed in some way, e.g. missing @@ -411,6 +414,9 @@ The server checks this, finds it is valid, and returns: { "access_token": "abcdef0123456789" } +The server may optionally return "user_id" to confirm or change the user's ID. +This is particularly useful if the home server wishes to support localpart entry +of usernames (e.g. "bob" rather than "@bob:matrix.org"). OAuth2-based ------------ |