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

Document the inhibit_login registration option

Browse source 
Fixes https://github.com/matrix-org/matrix-doc/issues/1351
This commit is contained in:
Travis Ralston 2018-08-28 18:36:07 -06:00
parent 132c5b0f48
commit 1051aff108
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -117,6 +117,13 @@ paths:
A display name to assign to the newly-created device. Ignored A display name to assign to the newly-created device. Ignored
if ``device_id`` corresponds to a known device. if ``device_id`` corresponds to a known device.
example: Jungle Phone example: Jungle Phone
inhibit_login:
type: boolean
description: |-
If true, an ``access_token`` and ``device_id`` should not be
returned from this call, therefore preventing an automatic
login. Defaults to false.
example: false
responses: responses:
200: 200:
description: The account has been registered. description: The account has been registered.
@ -141,6 +148,7 @@ paths:
description: |- description: |-
An access token for the account. An access token for the account.
This access token can then be used to authorize other requests. This access token can then be used to authorize other requests.
Required if the ``inhibit_login`` option is false.
home_server: home_server:
type: string type: string
description: |- description: |-
@ -155,6 +163,8 @@ paths:
description: |- description: |-
ID of the registered device. Will be the same as the ID of the registered device. Will be the same as the
corresponding parameter in the request, if one was specified. corresponding parameter in the request, if one was specified.
Required if the ``inhibit_login`` option is false.
required: ['user_id']
400: 400:
description: |- description: |-
Part of the request was invalid. This may include one of the following error codes: Part of the request was invalid. This may include one of the following error codes: