summary refs log tree commit diff
path: root/docs/specification.rst
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-08-28 14:56:55 +0100
committerKegan Dougal <kegan@matrix.org>2014-08-28 14:56:55 +0100
commit8d7d251c356f74a376053619f23057f0d6d8aa1e (patch)
tree8ad9aefa4539a190fee82ec789db7dabbbfc7430 /docs/specification.rst
parentFleshed out login spec. (diff)
downloadsynapse-8d7d251c356f74a376053619f23057f0d6d8aa1e.tar.xz
Support multiple login flows when deciding how to login. Updated cmdclient and spec. Webclient doesn't need updating for this.
Diffstat (limited to 'docs/specification.rst')
-rw-r--r--docs/specification.rst28
1 files changed, 15 insertions, 13 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index 8df5d478a1..30e4a7a3fb 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -230,19 +230,21 @@ with all the valid login flows when requested::
   The client can login via 3 paths: 1a and 1b, 2a and 2b, or 3. The client should
   select one of these paths.
   
-  [
-    {
-      "type": "<login type1a>",
-      "stages": [ "<login type 1a>", "<login type 1b>" ]
-    },
-    {
-      "type": "<login type2a>",
-      "stages": [ "<login type 2a>", "<login type 2b>" ]
-    },
-    {
-      "type": "<login type3>"
-    }
-  ]
+  {
+    "flows": [
+      {
+        "type": "<login type1a>",
+        "stages": [ "<login type 1a>", "<login type 1b>" ]
+      },
+      {
+        "type": "<login type2a>",
+        "stages": [ "<login type 2a>", "<login type 2b>" ]
+      },
+      {
+        "type": "<login type3>"
+      }
+    ]
+  }
 
 After the login is completed, the client's fully-qualified user ID and a new access 
 token MUST be returned::