From 1bda3fe2b20427be2e129ac2a91d7dc9bbd72215 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Sun, 26 May 2019 21:49:46 -0600
Subject: [PATCH] Spec MSISDN UIA support

Fixes https://github.com/matrix-org/matrix-doc/issues/1702

1702 describes the lack of `bind_msisdn` parameter, however the whole login type was missing from UIA.
---
 api/client-server/registration.yaml           |  6 ++++
 .../client_server/newsfragments/2030.feature  |  1 +
 specification/client_server_api.rst           | 29 +++++++++++++++++++
 3 files changed, 36 insertions(+)
 create mode 100644 changelogs/client_server/newsfragments/2030.feature

diff --git a/api/client-server/registration.yaml b/api/client-server/registration.yaml
index e2d35d2c2..741008bbc 100644
--- a/api/client-server/registration.yaml
+++ b/api/client-server/registration.yaml
@@ -94,6 +94,12 @@ paths:
                   If true, the server binds the email used for authentication to
                   the Matrix ID with the identity server.
                 example: false
+              bind_msisdn:
+                type: boolean
+                description: |-
+                  If true, the server binds the phone number used for authentication
+                  to the Matrix ID with the identity server.
+                example: false
               username:
                 type: string
                 description: |-
diff --git a/changelogs/client_server/newsfragments/2030.feature b/changelogs/client_server/newsfragments/2030.feature
new file mode 100644
index 000000000..b5975a737
--- /dev/null
+++ b/changelogs/client_server/newsfragments/2030.feature
@@ -0,0 +1 @@
+Add MSISDN (phone number) support to User-Interactive Authentication.
diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst
index 604c2b1c6..a40d463cb 100644
--- a/specification/client_server_api.rst
+++ b/specification/client_server_api.rst
@@ -618,6 +618,7 @@ This specification defines the following auth types:
  - ``m.login.recaptcha``
  - ``m.login.oauth2``
  - ``m.login.email.identity``
+ - ``m.login.msisdn``
  - ``m.login.token``
  - ``m.login.dummy``
 
@@ -782,6 +783,34 @@ To use this authentication type, clients should submit an auth dict as follows:
     "session": "<session ID>"
   }
 
+Phone number/MSISDN-based (identity server)
+<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+:Type:
+  ``m.login.msisdn``
+:Description:
+  Authentication is supported by authorising a phone number 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 homeserver.
+
+To use this authentication type, clients should submit an auth dict as follows:
+
+.. code:: json
+
+  {
+    "type": "m.login.msisdn",
+    "threepidCreds": [
+      {
+        "sid": "<identity server session id>",
+        "client_secret": "<identity server client secret>",
+        "id_server": "<url of identity server authed with, e.g. 'matrix.org:8090'>"
+      }
+    ],
+    "session": "<session ID>"
+  }
+
 Dummy Auth
 <<<<<<<<<<
 :Type: