diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2017-10-31 17:20:47 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-31 17:20:47 +0000 |
| commit | a72e4e3e2860694013dade663f46b82160d08add (patch) | |
| tree | c868dffb9cf270632649e54fe4ba7f4cc685b188 /docs/password_auth_providers.rst | |
| parent | Merge pull request #2611 from matrix-org/dbkr/port_script_drop_nuls (diff) | |
| parent | fix tests (diff) | |
| download | synapse-a72e4e3e2860694013dade663f46b82160d08add.tar.xz | |
Merge pull request #2610 from matrix-org/rav/schema_for_pw_providers
DB schema interface for password auth providers
Diffstat (limited to 'docs/password_auth_providers.rst')
| -rw-r--r-- | docs/password_auth_providers.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/password_auth_providers.rst b/docs/password_auth_providers.rst index 3da1a67844..ca05a76617 100644 --- a/docs/password_auth_providers.rst +++ b/docs/password_auth_providers.rst @@ -37,3 +37,15 @@ Password auth provider classes must provide the following methods: The method should return a Twisted ``Deferred`` object, which resolves to ``True`` if authentication is successful, and ``False`` if not. + +Optional methods +---------------- + +Password provider classes may optionally provide the following methods. + +*class* ``SomeProvider.get_db_schema_files()`` + + This method, if implemented, should return an Iterable of ``(name, + stream)`` pairs of database schema files. Each file is applied in turn at + initialisation, and a record is then made in the database so that it is + not re-applied on the next start. |