summary refs log tree commit diff
path: root/docs/specification.rst
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-09-15 15:27:17 +0100
committerKegan Dougal <kegan@matrix.org>2014-09-15 15:27:17 +0100
commit0b8a3bc3b91db723d431ca0d2d8978524b0a411f (patch)
treed5ada59d5e4fe5b0db73dfd4beffc28f72a866b2 /docs/specification.rst
parentFix unit tests. (diff)
downloadsynapse-0b8a3bc3b91db723d431ca0d2d8978524b0a411f.tar.xz
Update spec to include m.login.email.identity
Diffstat (limited to 'docs/specification.rst')
-rw-r--r--docs/specification.rst27
1 files changed, 26 insertions, 1 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index b06f14f8c9..a2e348fa2b 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -1379,7 +1379,7 @@ This specification defines the following login types:
  - ``m.login.oauth2``
  - ``m.login.email.code``
  - ``m.login.email.url``
-
+ - ``m.login.email.identity``
 
 Password-based
 --------------
@@ -1527,6 +1527,31 @@ If the link has not been visited yet, a standard error response with an errcode
 ``M_LOGIN_EMAIL_URL_NOT_YET`` should be returned.
 
 
+Email-based (identity server)
+-----------------------------
+:Type:
+  ``m.login.email.identity``
+:Description:
+  Login is supported by authorising an email address with an identity server.
+
+Prior to submitting this, the client should authenticate with an identity server.
+After authenticating, the session information should be submitted to the home server.
+
+To respond to this type, reply with::
+
+  {
+    "type": "m.login.email.identity",
+    "threepidCreds": [
+      {
+        "sid": "<identity server session id>",
+        "clientSecret": "<identity server client secret>",
+        "idServer": "<url of identity server authed with, e.g. 'matrix.org:8090'>"
+      }
+    ]
+  }
+
+
+
 N-Factor Authentication
 -----------------------
 Multiple login stages can be combined to create N-factor authentication during login.