MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 12:23:48 +01:00
Code Issues Projects Releases Wiki Activity

Improve comments on get_user_by_access_token

Browse source 
because I have to reverse-engineer this every time.
This commit is contained in:
Richard van der Hoff 2017-11-29 15:41:20 +00:00
parent 5a4da5bf78
commit da562bd6a1
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
synapse/api/auth.py
View file

@ -270,7 +270,11 @@ class Auth(object):
rights (str): The operation being performed; the access token must
allow this.
Returns:
dict : dict that includes the user and the ID of their access token.
Deferred[dict]: dict that includes:
`user` (UserID)
`is_guest` (bool)
`token_id` (int|None): access token id. May be None if guest
`device_id` (str|None): device corresponding to access token
Raises:
AuthError if no user by that token exists or the token is invalid.
"""