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

Document the user-interactive api params

Browse source 
Document the parameters and responses on /register and /account/password which
are invoved in the user-interactive auth
This commit is contained in:
Richard van der Hoff 2016-05-06 16:47:49 +01:00
parent 0cdc2da5bf
commit 9efd021f5e
4 changed files with 93 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
api/client-server/registration.yaml
View file

@ -39,26 +39,27 @@ paths:
name: body
schema:
type: object
example: |-
{
"username": "cheeky_monkey",
"password": "ilovebananas",
"bind_email": false
}
properties:
auth:
description: |-
Additional authentication information for the user-interactive authentication API.
"$ref": "definitions/auth_data.yaml"
bind_email:
type: boolean
description: |-
If true, the server binds the email used for authentication to
the Matrix ID with the ID Server.
example: false
username:
type: string
description: |-
The local part of the desired Matrix ID. If omitted,
the homeserver MUST generate a Matrix ID local part.
example: cheeky_monkey
password:
type: string
description: The desired password for the account.
example: ilovebananas
required: ["password"]
responses:
200:
@ -118,6 +119,11 @@ paths:
"errcode": "M_USER_IN_USE",
"error": "Desired user ID is already taken."
}
401:
description: |-
The homeserver requires additional authentication information.
schema:
"$ref": "definitions/auth_response.yaml"
429:
description: This request was rate-limited.
schema: