diff options
| author | Richard van der Hoff <richard@matrix.org> | 2017-11-29 15:41:20 +0000 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2017-11-29 15:52:41 +0000 |
| commit | da562bd6a105618e4358cb9ff08c1fb93d270947 (patch) | |
| tree | f4344b488c89058446a7d31b870372b4bc00e424 /synapse/api/auth.py | |
| parent | Merge pull request #2697 from matrix-org/rav/fix_urlcache_index_error (diff) | |
| download | synapse-da562bd6a105618e4358cb9ff08c1fb93d270947.tar.xz | |
Improve comments on get_user_by_access_token
because I have to reverse-engineer this every time.
Diffstat (limited to 'synapse/api/auth.py')
| -rw-r--r-- | synapse/api/auth.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/synapse/api/auth.py b/synapse/api/auth.py index 72858cca1f..ac0a3655a5 100644 --- a/synapse/api/auth.py +++ b/synapse/api/auth.py @@ -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. """ |