diff options
| author | David Baker <dbkr@users.noreply.github.com> | 2017-11-02 10:49:03 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-11-02 10:49:03 +0000 |
| commit | 1f080a6c9706f966aa668f5b56b2bd4950a586db (patch) | |
| tree | 4ef1c558f204d13b89c3489f4aa59e127a1cd972 /docs | |
| parent | Merge pull request #2622 from matrix-org/rav/db_access_for_auth_providers (diff) | |
| parent | Fix user-interactive password auth (diff) | |
| download | synapse-1f080a6c9706f966aa668f5b56b2bd4950a586db.tar.xz | |
Merge pull request #2623 from matrix-org/rav/callbacks_for_auth_providers
Allow password_auth_providers to return a callback
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/password_auth_providers.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/password_auth_providers.rst b/docs/password_auth_providers.rst index 2dbebcd72c..4ae4aeb53f 100644 --- a/docs/password_auth_providers.rst +++ b/docs/password_auth_providers.rst @@ -70,6 +70,11 @@ Password auth provider classes may optionally provide the following methods. the canonical ``@localpart:domain`` user id if authentication is successful, and ``None`` if not. + Alternatively, the ``Deferred`` can resolve to a ``(str, func)`` tuple, in + which case the second field is a callback which will be called with the + result from the ``/login`` call (including ``access_token``, ``device_id``, + etc.) + ``someprovider.check_password``\(*user_id*, *password*) This method provides a simpler interface than ``get_supported_login_types`` |