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

Spec device_id on whoami

Browse source 
Spec for https://github.com/matrix-org/matrix-doc/pull/2033
This commit is contained in:
Travis Ralston 2021-05-01 21:21:13 -06:00 • committed by Richard van der Hoff
parent 457f3995af
commit 3b2c0ff233
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
data/api/client-server/whoami.yaml
View file

@ -47,7 +47,8 @@ paths:
The token belongs to a known user. The token belongs to a known user.
examples: examples:
application/json: { application/json: {
"user_id": "@joe:example.org" "user_id": "@joe:example.org",
"device_id": "ABC1234"
} }
schema: schema:
type: object type: object
@ -55,7 +56,14 @@ paths:
properties: properties:
user_id: user_id:
type: string type: string
description: The user id that owns the access token. description: The user ID that owns the access token.
device_id:
type: string
description: |-
Device ID associated with the access token. If no device
is associated with the access token (such as in the case
of application services) then this field can be omitted.
Otherwise this is required.
401: 401:
description: description:
The token is not recognised The token is not recognised