diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2017-11-29 17:57:06 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-11-29 17:57:06 +0000 |
| commit | 624c46eb06c0058304860371b672f5b0e730321b (patch) | |
| tree | 3c3f0f5e54ea998b027ef57994900847db7a6c37 /synapse/api/auth.py | |
| parent | Merge pull request #2722 from matrix-org/rav/delete_device_on_logout (diff) | |
| parent | Improve comments on get_user_by_access_token (diff) | |
| download | synapse-624c46eb06c0058304860371b672f5b0e730321b.tar.xz | |
Merge pull request #2721 from matrix-org/rav/get_user_by_access_token_comments
Improve comments on get_user_by_access_token
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. """ |