This documentation site is for the versions of Synapse maintained by the Matrix.org Foundation (github.com/matrix-org/synapse), available under the Apache 2.0 licence.
user_id - A fully-qualified user id. For example, @user:server.com.
Body parameters:
password - string, optional. If provided, the user's password is updated and all
devices are logged out, unless logout_devices is set to false.
logout_devices - bool, optional, defaults to true. If set to false, devices aren't
logged out even when password is provided.
displayname - string, optional. If set to an empty string (""), the user's display name
will be removed.
avatar_url - string, optional. Must be a
MXC URI.
If set to an empty string (""), the user's avatar is removed.
threepids - array, optional. If provided, the user's third-party IDs (email, msisdn) are
entirely replaced with the given list. Each item in the array is an object with the following
fields:
medium - string, required. The type of third-party ID, either email or msisdn (phone number).
address - string, required. The third-party ID itself, e.g. alice@example.com for email or
447470274584 (for a phone number with country code "44") and 19254857364 (for a phone number
with country code "1") for msisdn.
Note: If a threepid is removed from a user via this option, Synapse will also attempt to remove
that threepid from any identity servers it is aware has a binding for it.
external_ids - array, optional. Allow setting the identifier of the external identity
provider for SSO (Single sign-on). More details are in the configuration manual under the
sections sso and oidc_providers.
auth_provider - string, required. The unique, internal ID of the external identity provider.
The same as idp_id from the homeserver configuration. Note that no error is raised if the
provided value is not in the homeserver configuration.
external_id - string, required. An identifier for the user in the external identity provider.
When the user logs in to the identity provider, this must be the unique ID that they map to.
admin - bool, optional, defaults to false. Whether the user is a homeserver administrator,
granting them access to the Admin API, among other things.
deactivated - bool, optional. If unspecified, deactivation state will be left unchanged.
Note: the password field must also be set if both of the following are true:
deactivated is set to false and the user was previously deactivated (you are reactivating this user)
Users are allowed to set their password on this homeserver (both password_config.enabled and
password_config.localdb_enabled config options are set to true).
Users' passwords are wiped upon account deactivation, hence the need to set a new one here.
Note: a user cannot be erased with this API. For more details on
deactivating and erasing users see Deactivate Account.
locked - bool, optional. If unspecified, locked state will be left unchanged.
user_type - string or null, optional. If not provided, the user type will be
not be changed. If null is given, the user type will be cleared.
Other allowed options are: bot and support.
To paginate, check for next_token and if present, call the endpoint again
with from set to the value of next_token. This will return a new page.
If the endpoint does not return a next_token then there are no more users
to paginate through.
Parameters
The following parameters should be set in the URL:
user_id - Is optional and filters to only return users with user IDs
that contain this value. This parameter is ignored when using the name parameter.
name - Is optional and filters to only return users with user ID localparts
or displaynames that contain this value.
guests - string representing a bool - Is optional and if false will exclude guest users.
Defaults to true to include guest users. This parameter is not supported when MSC3861 is enabled. See #15582
admins - Optional flag to filter admins. If true, only admins are queried. If false, admins are excluded from
the query. When the flag is absent (the default), both admins and non-admins are included in the search results.
deactivated - string representing a bool - Is optional and if true will include deactivated users.
Defaults to false to exclude deactivated users.
limit - string representing a positive integer - Is optional but is used for pagination,
denoting the maximum number of items to return in this call. Defaults to 100.
from - string representing a positive integer - Is optional but used for pagination,
denoting the offset in the returned results. This should be treated as an opaque value and
not explicitly set to anything other than the return value of next_token from a previous call.
Defaults to 0.
order_by - The method by which to sort the returned list of users.
If the ordered field has duplicates, the second order is always by ascending name,
which guarantees a stable ordering. Valid values are:
name - Users are ordered alphabetically by name. This is the default.
is_guest - Users are ordered by is_guest status.
admin - Users are ordered by admin status.
user_type - Users are ordered alphabetically by user_type.
deactivated - Users are ordered by deactivated status.
shadow_banned - Users are ordered by shadow_banned status.
displayname - Users are ordered alphabetically by displayname.
avatar_url - Users are ordered alphabetically by avatar URL.
creation_ts - Users are ordered by when the users was created in ms.
last_seen_ts - Users are ordered by when the user was lastly seen in ms.
dir - Direction of media order. Either f for forwards or b for backwards.
Setting this value to b will reverse the above sort order. Defaults to f.
not_user_type - Exclude certain user types, such as bot users, from the request.
Can be provided multiple times. Possible values are bot, support or "empty string".
"empty string" here means to exclude users without a type.
locked - string representing a bool - Is optional and if true will include locked users.
Defaults to false to exclude locked users. Note: Introduced in v1.93.
Caution. The database only has indexes on the columns name and creation_ts.
This means that if a different sort order is used (is_guest, admin,
user_type, deactivated, shadow_banned, avatar_url or displayname),
this can cause a large load on the database, especially for large environments.
Response
The following fields are returned in the JSON response body:
users - An array of objects, each containing information about an user.
User objects contain the following fields:
name - string - Fully-qualified user ID (ex. @user:server.com).
is_guest - bool - Status if that user is a guest account.
admin - bool - Status if that user is a server administrator.
user_type - string - Type of the user. Normal users are type None.
This allows user type specific behaviour. There are also types support and bot.
deactivated - bool - Status if that user has been marked as deactivated.
erased - bool - Status if that user has been marked as erased.
shadow_banned - bool - Status if that user has been marked as shadow banned.
displayname - string - The user's display name if they have set one.
avatar_url - string - The user's avatar URL if they have set one.
creation_ts - integer - The user's creation timestamp in ms.
last_seen_ts - integer - The user's last activity timestamp in ms.
locked - bool - Status if that user has been marked as locked. Note: Introduced in v1.93.
next_token: string representing a positive integer - Indication for pagination. See above.
total - integer - Total number of media.
Added in Synapse 1.93: the locked query parameter and response field.
This API deactivates an account. It removes active access tokens, resets the
password, and deletes third-party IDs (to prevent the user requesting a
password reset).
It can also mark the user as GDPR-erased. This means messages sent by the
user will still be visible by anyone that was in the room when these messages
were sent, but hidden from users joining the room afterwards.
The api is:
POST /_synapse/admin/v1/deactivate/<user_id>
with a body of:
{
"erase": true
}
The erase parameter is optional and defaults to false.
An empty body may be passed for backwards compatibility.
The following actions are performed when deactivating an user:
Try to unbind 3PIDs from the identity server
Remove all 3PIDs from the homeserver
Delete all devices and E2EE keys
Delete all access tokens
Delete all pushers
Delete the password hash
Removal from all rooms the user is a member of
Remove the user from the user directory
Reject all pending invites
Remove all account validity information related to the user
Remove the arbitrary data store known as account data. For example, this includes:
list of ignored users;
push rules;
secret storage keys; and
cross-signing keys.
The following additional actions are performed during deactivation if erase
is set to true:
Remove the user's display name
Remove the user's avatar URL
Mark the user as erased
The following actions are NOT performed. The list may be incomplete.
The server returns the list of rooms of which the user and the server
are member. If the user is local, all the rooms of which the user is
member are returned.
Parameters
The following parameters should be set in the URL:
user_id - fully qualified: for example, @user:server.com.
Response
The following fields are returned in the JSON response body:
Gets a list of all local media that a specific user_id has created.
These are media that the user has uploaded themselves
(local media), as well as
URL preview images requested by the user if the
feature is enabled.
By default, the response is ordered by descending creation date and ascending media ID.
The newest media is on top. You can change the order with parameters
order_by and dir.
To paginate, check for next_token and if present, call the endpoint again
with from set to the value of next_token. This will return a new page.
If the endpoint does not return a next_token then there are no more
reports to paginate through.
Parameters
The following parameters should be set in the URL:
user_id - string - fully qualified: for example, @user:server.com.
limit: string representing a positive integer - Is optional but is used for pagination,
denoting the maximum number of items to return in this call. Defaults to 100.
from: string representing a positive integer - Is optional but used for pagination,
denoting the offset in the returned results. This should be treated as an opaque value and
not explicitly set to anything other than the return value of next_token from a previous call.
Defaults to 0.
order_by - The method by which to sort the returned list of media.
If the ordered field has duplicates, the second order is always by ascending media_id,
which guarantees a stable ordering. Valid values are:
media_id - Media are ordered alphabetically by media_id.
upload_name - Media are ordered alphabetically by name the media was uploaded with.
created_ts - Media are ordered by when the content was uploaded in ms.
Smallest to largest. This is the default.
last_access_ts - Media are ordered by when the content was last accessed in ms.
Smallest to largest.
media_length - Media are ordered by length of the media in bytes.
Smallest to largest.
media_type - Media are ordered alphabetically by MIME-type.
quarantined_by - Media are ordered alphabetically by the user ID that
initiated the quarantine request for this media.
safe_from_quarantine - Media are ordered by the status if this media is safe
from quarantining.
dir - Direction of media order. Either f for forwards or b for backwards.
Setting this value to b will reverse the above sort order. Defaults to f.
If neither order_by nor dir is set, the default order is newest media on top
(corresponds to order_by = created_ts and dir = b).
Caution. The database only has indexes on the columns media_id,
user_id and created_ts. This means that if a different sort order is used
(upload_name, last_access_ts, media_length, media_type,
quarantined_by or safe_from_quarantine), this can cause a large load on the
database, especially for large environments.
Response
The following fields are returned in the JSON response body:
media - An array of objects, each containing information about a media.
Media objects contain the following fields:
created_ts - integer - Timestamp when the content was uploaded in ms.
last_access_ts - integer or null - Timestamp when the content was last accessed in ms.
Null if there was no access, yet.
media_id - string - The id used to refer to the media. Details about the format
are documented under
media repository.
media_length - integer - Length of the media in bytes.
media_type - string - The MIME-type of the media.
quarantined_by - string or null - The user ID that initiated the quarantine request
for this media. Null if not quarantined.
safe_from_quarantine - bool - Status if this media is safe from quarantining.
upload_name - string or null - The name the media was uploaded with. Null if not provided during upload.
next_token: integer - Indication for pagination. See above.
This API deletes the local media from the disk of your own server
that a specific user_id has created. This includes any local thumbnails.
This API will not affect media that has been uploaded to external
media repositories (e.g https://github.com/turt2live/matrix-media-repo/).
By default, the API deletes media ordered by descending creation date and ascending media ID.
The newest media is deleted first. You can change the order with parameters
order_by and dir. If no limit is set the API deletes 100 files per request.
The following fields are returned in the JSON response body:
deleted_media: an array of strings - List of deleted media_id
total: integer - Total number of deleted media_id
Note: There is no next_token. This is not useful for deleting media, because
after deleting media the remaining media have a new order.
Parameters
This API has the same parameters as
List media uploaded by a user.
With the parameters you can for example limit the number of files to delete at once or
delete largest/smallest or newest/oldest files first.
Note: This API is disabled when MSC3861 is enabled. See #15582
Get an access token that can be used to authenticate as that user. Useful for
when admins wish to do actions on behalf of a user.
The API is:
POST /_synapse/admin/v1/users/<user_id>/login
{}
An optional valid_until_ms field can be specified in the request body as an
integer timestamp that specifies when the token should expire. By default tokens
do not expire. Note that this API does not allow a user to login as themselves
(to create more tokens).
This API does not generate a new device for the user, and so will not appear
their /devices list, and in general the target user should not be able to
tell they have been logged in as.
To expire the token call the standard /logout API with the token.
Note: The token will expire if the admin user calls /logout/all from any
of their devices, but the token will not expire if the target user does the
same.
This endpoint is not intended for server administrator usage;
we describe it here for completeness.
This API temporarily permits a user to replace their master cross-signing key
without going through
user-interactive authentication (UIA).
This is useful when Synapse has delegated its authentication to the
Matrix Authentication Service;
as Synapse cannot perform UIA is not possible in these circumstances.
The API is
POST /_synapse/admin/v1/users/<user_id>/_allow_cross_signing_replacement_without_uia
{}
If the user does not exist, or does exist but has no master cross-signing key,
this will return with status code 404 Not Found.
Otherwise, a response body like the following is returned, with status 200 OK:
{
"updatable_without_uia_before_ms": 1234567890
}
The response body is a JSON object with a single field:
updatable_without_uia_before_ms: integer. The timestamp in milliseconds
before which the user is permitted to replace their cross-signing key without
going through UIA.
The following parameters should be set in the URL:
user_id - fully qualified: for example, @user:server.com.
Response
The following fields are returned in the JSON response body:
devices - An array of objects, each containing information about a device.
Device objects contain the following fields:
device_id - Identifier of device.
display_name - Display name set by the user for this device.
Absent if no name has been set.
last_seen_ip - The IP address where this device was last seen.
(May be a few minutes out of date, for efficiency reasons).
last_seen_user_agent - The user agent of the device when it was last seen.
(May be a few minutes out of date, for efficiency reasons).
last_seen_ts - The timestamp (in milliseconds since the unix epoch) when this
devices was last seen. (May be a few minutes out of date, for efficiency reasons).
The following parameters should be set in the URL:
user_id - fully qualified: for example, @user:server.com.
device_id - The device to retrieve.
Response
The following fields are returned in the JSON response body:
device_id - Identifier of device.
display_name - Display name set by the user for this device.
Absent if no name has been set.
last_seen_ip - The IP address where this device was last seen.
(May be a few minutes out of date, for efficiency reasons).
last_seen_user_agent - The user agent of the device when it was last seen.
(May be a few minutes out of date, for efficiency reasons).
last_seen_ts - The timestamp (in milliseconds since the unix epoch) when this
devices was last seen. (May be a few minutes out of date, for efficiency reasons).
Shadow-banning is a useful tool for moderating malicious or egregiously abusive users.
A shadow-banned users receives successful responses to their client-server API requests,
but the events are not propagated into rooms. This can be an effective tool as it
(hopefully) takes longer for the user to realise they are being moderated before
pivoting to another account.
Shadow-banning a user should be used as a tool of last resort and may lead to confusing
or broken behaviour for the client. A shadow-banned user will not receive any
notification and it is generally more appropriate to ban or kick abusive users.
A shadow-banned user will be unable to contact anyone on the server.
To shadow-ban a user the API is:
POST /_synapse/admin/v1/users/<user_id>/shadow_ban
GET /_synapse/admin/v1/auth_providers/$provider/users/$external_id
When a user matched the given ID for the given provider, an HTTP code 200 with a response body like the following is returned:
{
"user_id": "@hello:example.org"
}
Parameters
The following parameters should be set in the URL:
provider - The ID of the authentication provider, as advertised by the GET /_matrix/client/v3/login API in the m.login.sso authentication method.
external_id - The user ID from the authentication provider. Usually corresponds to the sub claim for OIDC providers, or to the uid attestation for SAML2 providers.
The external_id may have characters that are not URL-safe (typically /, : or @), so it is advised to URL-encode those parameters.
Errors
Returns a 404 HTTP status code if no user was found, with a response body like this:
{
"errcode":"M_NOT_FOUND",
"error":"User not found"
}