summary refs log tree commit diff
path: root/docs/modules
diff options
context:
space:
mode:
authorRory& <root@rory.gay>2025-06-28 05:51:19 +0200
committerRory& <root@rory.gay>2025-06-28 05:51:19 +0200
commit3c8883fa627945f50957f431a3c07b55c8d10862 (patch)
treed80423df10d73456d904ca009d9a30348784e68c /docs/modules
parentTEMP: expose server error tracebacks (diff)
downloadsynapse-3c8883fa627945f50957f431a3c07b55c8d10862.tar.xz
Remove 3pid and identity servers
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/password_auth_provider_callbacks.md30
-rw-r--r--docs/modules/third_party_rules_callbacks.md81
2 files changed, 0 insertions, 111 deletions
diff --git a/docs/modules/password_auth_provider_callbacks.md b/docs/modules/password_auth_provider_callbacks.md

index d66ac7df31..6b3105de34 100644 --- a/docs/modules/password_auth_provider_callbacks.md +++ b/docs/modules/password_auth_provider_callbacks.md
@@ -144,16 +144,6 @@ Here's an example featuring all currently supported keys: "m.login.dummy": True, # Dummy authentication "m.login.terms": True, # User has accepted the terms of service for the homeserver "m.login.recaptcha": True, # User has completed the recaptcha challenge - "m.login.email.identity": { # User has provided and verified an email address - "medium": "email", - "address": "alice@example.com", - "validated_at": 1642701357084, - }, - "m.login.msisdn": { # User has provided and verified a phone number - "medium": "msisdn", - "address": "33123456789", - "validated_at": 1642701357084, - }, "m.login.registration_token": "sometoken", # User has registered through a registration token } ``` @@ -200,26 +190,6 @@ callback that does not return `None` will be used. If this happens, Synapse will any of the subsequent implementations of this callback. If every callback returns `None`, the username will be used (e.g. `alice` if the user being registered is `@alice:example.com`). -## `is_3pid_allowed` - -_First introduced in Synapse v1.53.0_ - -```python -async def is_3pid_allowed(self, medium: str, address: str, registration: bool) -> bool -``` - -Called when attempting to bind a third-party identifier (i.e. an email address or a phone -number). The module is given the medium of the third-party identifier (which is `email` if -the identifier is an email address, or `msisdn` if the identifier is a phone number) and -its address, as well as a boolean indicating whether the attempt to bind is happening as -part of registering a new user. The module must return a boolean indicating whether the -identifier can be allowed to be bound to an account on the local homeserver. - -If multiple modules implement this callback, they will be considered in order. If a -callback returns `True`, Synapse falls through to the next one. The value of the first -callback that does not return `True` will be used. If this happens, Synapse will not call -any of the subsequent implementations of this callback. - ## Example The example module below implements authentication checkers for two different login types: diff --git a/docs/modules/third_party_rules_callbacks.md b/docs/modules/third_party_rules_callbacks.md
index b97e28db11..b4162a317d 100644 --- a/docs/modules/third_party_rules_callbacks.md +++ b/docs/modules/third_party_rules_callbacks.md
@@ -86,26 +86,6 @@ room creation will be forbidden as soon as one of the callbacks raises an except this happens, Synapse will not call any of the subsequent implementations of this callback. -### `check_threepid_can_be_invited` - -_First introduced in Synapse v1.39.0_ - -```python -async def check_threepid_can_be_invited( - medium: str, - address: str, - state_events: "synapse.types.StateMap", -) -> bool: -``` - -Called when processing an invite via a third-party identifier (i.e. email or phone number). -The module must return a boolean indicating whether the invite can go through. - -If multiple modules implement this callback, they will be considered in order. If a -callback returns `True`, Synapse falls through to the next one. The value of the first -callback that does not return `True` will be used. If this happens, Synapse will not call -any of the subsequent implementations of this callback. - ### `check_visibility_can_be_modified` _First introduced in Synapse v1.39.0_ @@ -254,67 +234,6 @@ admin API. If multiple modules implement this callback, Synapse runs them all in order. -### `on_threepid_bind` - -_First introduced in Synapse v1.56.0_ - -**<span style="color:red"> -This callback is deprecated in favour of the `on_add_user_third_party_identifier` callback, which -features the same functionality. The only difference is in name. -</span>** - -```python -async def on_threepid_bind(user_id: str, medium: str, address: str) -> None: -``` - -Called after creating an association between a local user and a third-party identifier -(email address, phone number). The module is given the Matrix ID of the user the -association is for, as well as the medium (`email` or `msisdn`) and address of the -third-party identifier. - -Note that this callback is _not_ called after a successful association on an _identity -server_. - -If multiple modules implement this callback, Synapse runs them all in order. - -### `on_add_user_third_party_identifier` - -_First introduced in Synapse v1.79.0_ - -```python -async def on_add_user_third_party_identifier(user_id: str, medium: str, address: str) -> None: -``` - -Called after successfully creating an association between a user and a third-party identifier -(email address, phone number). The module is given the Matrix ID of the user the -association is for, as well as the medium (`email` or `msisdn`) and address of the -third-party identifier (i.e. an email address). - -Note that this callback is _not_ called if a user attempts to bind their third-party identifier -to an identity server (via a call to [`POST -/_matrix/client/v3/account/3pid/bind`](https://spec.matrix.org/v1.5/client-server-api/#post_matrixclientv3account3pidbind)). - -If multiple modules implement this callback, Synapse runs them all in order. - -### `on_remove_user_third_party_identifier` - -_First introduced in Synapse v1.79.0_ - -```python -async def on_remove_user_third_party_identifier(user_id: str, medium: str, address: str) -> None: -``` - -Called after successfully removing an association between a user and a third-party identifier -(email address, phone number). The module is given the Matrix ID of the user the -association is for, as well as the medium (`email` or `msisdn`) and address of the -third-party identifier (i.e. an email address). - -Note that this callback is _not_ called if a user attempts to unbind their third-party -identifier from an identity server (via a call to [`POST -/_matrix/client/v3/account/3pid/unbind`](https://spec.matrix.org/v1.5/client-server-api/#post_matrixclientv3account3pidunbind)). - -If multiple modules implement this callback, Synapse runs them all in order. - ## Example The example below is a module that implements the third-party rules callback