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

Merge pull request #2721 from matrix-org/rav/get_user_by_access_token_comments

Browse source 
Improve comments on get_user_by_access_token
This commit is contained in:
Richard van der Hoff 2017-11-29 17:57:06 +00:00 committed by GitHub
commit 624c46eb06
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
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.
"""