wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update the /login API spec

Browse source 
Note that /login can be used with 3pid creds
This commit is contained in:
Richard van der Hoff 2016-05-06 16:51:31 +01:00
parent 0cdc2da5bf
commit 959f1ff09f
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
api/client-server/login.yaml
View file

@ -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.