Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-04 15:03:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improve documentation around /account/whoami

Browse source 
Clarifies: https://github.com/matrix-org/matrix-doc/issues/1135

Signed-off-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Travis Ralston 2018-03-06 13:41:53 -07:00
parent 8c61da287d
commit 2e4e5e25e8
1 changed files with 33 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
api/client-server/whoami.yaml
View file

@ -29,7 +29,13 @@ paths:
get:
summary: Gets information about the owner of an access token.
description: |-
Gets information about the owner of a given access token.
Gets information about the owner of a given access token.
If the owner of the access token is an application service,
the server should return the user ID making the request. The
server should respect the application service client/server API
extensions during this request. If the request is made for a
virtual user, the server should verify that it is registered.
operationId: getTokenOwner
security:
- accessToken: []
@ -40,8 +46,8 @@ paths:
The token belongs to a known user.
examples:
application/json: {
"user_id": "@joe:example.org"
}
"user_id": "@joe:example.org"
}
schema:
type: object
required: ["user_id"]
@ -49,5 +55,29 @@ paths:
user_id:
type: string
description: The user id that owns the access token.
401:
description:
The token is not recongized
examples:
application/json: {
"errcode": "M_UNKNOWN_TOKEN",
"error": "Unrecongised access token."
}
schema:
"$ref": "definitions/error.yaml"
403:
description:
The appservice cannot masquerade the user or has not registered them.
examples:
application/json: {
"errcode": "M_FORBIDDEN",
"error": "Application service has not registered this user."
}
schema:
"$ref": "definitions/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/error.yaml"
tags:
- User data