diff options
| author | Andrew Yasinishyn <yasinishyn.a.n@gmail.com> | 2023-12-01 16:31:50 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-01 14:31:50 +0000 |
| commit | 63d96bfc61fcbf53e9607c63f215d2dde387de29 (patch) | |
| tree | 59f4d2bab25d0b39e291cc1063132170f846eec9 /docs/modules | |
| parent | Drop unused tables & unneeded access token ID for events. (#16522) (diff) | |
| download | synapse-63d96bfc61fcbf53e9607c63f215d2dde387de29.tar.xz | |
ModuleAPI SSO auth callbacks (#15207)
Signed-off-by: Andrii Yasynyshyn yasinishyn.a.n@gmail.com
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/account_validity_callbacks.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/modules/account_validity_callbacks.md b/docs/modules/account_validity_callbacks.md index 3cd0e72198..f5eefcd7d6 100644 --- a/docs/modules/account_validity_callbacks.md +++ b/docs/modules/account_validity_callbacks.md @@ -42,3 +42,16 @@ operations to keep track of them. (e.g. add them to a database table). The user represented by their Matrix user ID. If multiple modules implement this callback, Synapse runs them all in order. + +### `on_user_login` + +_First introduced in Synapse v1.98.0_ + +```python +async def on_user_login(user_id: str, auth_provider_type: str, auth_provider_id: str) -> None +``` + +Called after successfully login or registration of a user for cases when module needs to perform extra operations after auth. +represented by their Matrix user ID. + +If multiple modules implement this callback, Synapse runs them all in order. |