From 959f1ff09f69b0276505e18178d6c5f1a7008d02 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 6 May 2016 16:51:31 +0100 Subject: [PATCH] Update the /login API spec Note that /login can be used with 3pid creds --- api/client-server/login.yaml | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/api/client-server/login.yaml b/api/client-server/login.yaml index bbe0befa5..6de8caa4b 100644 --- a/api/client-server/login.yaml +++ b/api/client-server/login.yaml @@ -18,10 +18,8 @@ paths: post: summary: Authenticates the user. description: |- - Authenticates the user by password, and issues an access token they can + Authenticates the user, and issues an access token they can use to authorize themself in subsequent requests. - security: - - accessToken: [] parameters: - in: body name: body @@ -40,10 +38,17 @@ paths: user: type: string description: The fully qualified user ID or just local part of the user ID, to log in. + medium: + type: string + description: When logging in using a third party identifier, the medium of the identifier. Must be 'email'. + address: + type: string + description: Third party identifier for the user. password: type: string description: The user's password. - required: ["type", "user", "password"] + required: ["type", "password"] + responses: 200: description: The user has been authenticated.