Skip to content

Commit

Permalink
Spec device_id on whoami
Browse files Browse the repository at this point in the history
Spec for #2033
  • Loading branch information
turt2live authored and richvdh committed Aug 27, 2021
1 parent 457f399 commit 3b2c0ff
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions data/api/client-server/whoami.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,23 @@ paths:
The token belongs to a known user.
examples:
application/json: {
"user_id": "@joe:example.org"
"user_id": "@joe:example.org",
"device_id": "ABC1234"
}
schema:
type: object
required: ["user_id"]
properties:
user_id:
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:
description:
The token is not recognised
Expand Down

0 comments on commit 3b2c0ff

Please sign in to comment.