mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-05-02 07:04:09 +02:00
Compare commits
9 commits
cefef01284
...
358216710d
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
358216710d | ||
|
|
6b6d351ef8 | ||
|
|
f62aa09e60 | ||
|
|
ef010cd408 | ||
|
|
bb3daafe96 | ||
|
|
a6da9443da | ||
|
|
cbff6790c3 | ||
|
|
8b7187927d | ||
|
|
c578129bed |
1
changelogs/appendices/newsfragments/2307.clarification
Normal file
1
changelogs/appendices/newsfragments/2307.clarification
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add identifier pronunciation guidelines. Contributed by @HarHarLinks.
|
||||||
1
changelogs/client_server/newsfragments/2278.feature
Normal file
1
changelogs/client_server/newsfragments/2278.feature
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add administrator endpoints to lock and suspend server-local users and add the `m.account_management` capability, as per [MSC4323](https://github.com/matrix-org/matrix-spec-proposals/pull/4323).
|
||||||
1
changelogs/client_server/newsfragments/2278.new.1
Normal file
1
changelogs/client_server/newsfragments/2278.new.1
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add `GET /_matrix/client/v1/admin/suspend/{userId}`, as per [MSC4323](https://github.com/matrix-org/matrix-spec-proposals/pull/4323).
|
||||||
1
changelogs/client_server/newsfragments/2278.new.2
Normal file
1
changelogs/client_server/newsfragments/2278.new.2
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add `PUT /_matrix/client/v1/admin/suspend/{userId}`, as per [MSC4323](https://github.com/matrix-org/matrix-spec-proposals/pull/4323).
|
||||||
1
changelogs/client_server/newsfragments/2278.new.3
Normal file
1
changelogs/client_server/newsfragments/2278.new.3
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add `GET /_matrix/client/v1/admin/lock/{userId}`, as per [MSC4323](https://github.com/matrix-org/matrix-spec-proposals/pull/4323).
|
||||||
1
changelogs/client_server/newsfragments/2278.new.4
Normal file
1
changelogs/client_server/newsfragments/2278.new.4
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add `PUT /_matrix/client/v1/admin/lock/{userId}`, as per [MSC4323](https://github.com/matrix-org/matrix-spec-proposals/pull/4323).
|
||||||
1
changelogs/client_server/newsfragments/2299.feature
Normal file
1
changelogs/client_server/newsfragments/2299.feature
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Clients supporting the `ol` HTML element must also support the `start` attribute, as per [MSC4313](https://github.com/matrix-org/matrix-spec-proposals/pull/4313).
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Clarify the requiredness of `event_id` in `predecessor`.
|
||||||
1
changelogs/client_server/newsfragments/2305.feature
Normal file
1
changelogs/client_server/newsfragments/2305.feature
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add invite blocking, as per [MSC4380](https://github.com/matrix-org/matrix-spec-proposals/pull/4380).
|
||||||
1
changelogs/internal/newsfragments/2317.clarification
Normal file
1
changelogs/internal/newsfragments/2317.clarification
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Update the footer social links to match matrix.org. Contributed by @HarHarLinks.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Clarify what the `minimum_valid_until_ts` field means when it is set in key queries.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Specify validation for PDUs passed to and returned from federation membership endpoints.
|
||||||
|
|
@ -115,11 +115,6 @@ sidebar_menu_compact = true
|
||||||
url = "https://gitlab.matrix.org/matrix-org"
|
url = "https://gitlab.matrix.org/matrix-org"
|
||||||
icon = "fab fa-gitlab"
|
icon = "fab fa-gitlab"
|
||||||
desc = "Matrix on GitLab"
|
desc = "Matrix on GitLab"
|
||||||
[[params.links.bottom]]
|
|
||||||
name = "YouTube"
|
|
||||||
url = "https://www.youtube.com/channel/UCVFkW-chclhuyYRbmmfwt6w"
|
|
||||||
icon = "fab fa-youtube"
|
|
||||||
desc = "Matrix YouTube channel"
|
|
||||||
[[params.links.bottom]]
|
[[params.links.bottom]]
|
||||||
name = "Mastodon"
|
name = "Mastodon"
|
||||||
url = "https://mastodon.matrix.org/@matrix"
|
url = "https://mastodon.matrix.org/@matrix"
|
||||||
|
|
@ -130,6 +125,21 @@ sidebar_menu_compact = true
|
||||||
url = "https://bsky.app/profile/matrix.org"
|
url = "https://bsky.app/profile/matrix.org"
|
||||||
icon = "fab fa-bluesky"
|
icon = "fab fa-bluesky"
|
||||||
desc = "Matrix on Bluesky"
|
desc = "Matrix on Bluesky"
|
||||||
|
[[params.links.bottom]]
|
||||||
|
name = "LinkedIn"
|
||||||
|
url = "https://www.linkedin.com/company/matrix-org/"
|
||||||
|
icon = "fab fa-linkedin"
|
||||||
|
desc = "Matrix on LinkedIn"
|
||||||
|
[[params.links.bottom]]
|
||||||
|
name = "YouTube"
|
||||||
|
url = "https://www.youtube.com/channel/UCVFkW-chclhuyYRbmmfwt6w"
|
||||||
|
icon = "fab fa-youtube"
|
||||||
|
desc = "Matrix YouTube channel"
|
||||||
|
[[params.links.bottom]]
|
||||||
|
name = "Matrix.org Blog Feed"
|
||||||
|
url = "https://matrix.org/atom.xml"
|
||||||
|
icon = "fas fa-rss"
|
||||||
|
desc = "Matrix.org Blog Atom Feed"
|
||||||
|
|
||||||
|
|
||||||
# configuration for the hugo development server
|
# configuration for the hugo development server
|
||||||
|
|
|
||||||
|
|
@ -533,6 +533,11 @@ where `domain` is the [server name](#server-name) of the homeserver
|
||||||
which allocated the identifier, and `localpart` is an identifier
|
which allocated the identifier, and `localpart` is an identifier
|
||||||
allocated by that homeserver.
|
allocated by that homeserver.
|
||||||
|
|
||||||
|
Because the domain part identifies the server on which the ID resolves,
|
||||||
|
the canonical pronunciation of the separating `:` is "on".
|
||||||
|
For example, `@user:matrix.org` would be pronounced as "at user on matrix dot
|
||||||
|
org".
|
||||||
|
|
||||||
The precise grammar defining the allowable format of an identifier
|
The precise grammar defining the allowable format of an identifier
|
||||||
depends on the type of identifier. For example, event IDs can sometimes
|
depends on the type of identifier. For example, event IDs can sometimes
|
||||||
be represented with a `domain` component under some conditions - see the
|
be represented with a `domain` component under some conditions - see the
|
||||||
|
|
|
||||||
|
|
@ -2394,9 +2394,12 @@ where feasible. The Matrix-specific actions are:
|
||||||
Server administrators may apply locks to prevent users from usefully
|
Server administrators may apply locks to prevent users from usefully
|
||||||
using their accounts, for instance, due to safety or security concerns.
|
using their accounts, for instance, due to safety or security concerns.
|
||||||
In contrast to account deactivation, locking is a non-destructive action
|
In contrast to account deactivation, locking is a non-destructive action
|
||||||
that can be reversed. This specification describes the behaviour of clients
|
that can be reversed.
|
||||||
and servers when an account is locked. It deliberately leaves the methods
|
|
||||||
for locking and unlocking accounts as a server implementation detail.
|
{{% added-in v="1.18" %}} To lock or unlock an account, administrators
|
||||||
|
SHOULD use the [`PUT /admin/lock/{userId}`](#put_matrixclientv1adminlockuserid)
|
||||||
|
endpoint. They MAY also use [`GET /admin/lock/{userId}`](#get_matrixclientv1adminlockuserid)
|
||||||
|
to check whether a user's account is locked.
|
||||||
|
|
||||||
When an account is locked, servers MUST return a `401 Unauthorized` error
|
When an account is locked, servers MUST return a `401 Unauthorized` error
|
||||||
response with an `M_USER_LOCKED` error code and [`soft_logout`](#soft-logout)
|
response with an `M_USER_LOCKED` error code and [`soft_logout`](#soft-logout)
|
||||||
|
|
@ -2445,6 +2448,11 @@ from that account. The effect is similar to [locking](#account-locking), though
|
||||||
without risk of the client losing state from a logout. Suspensions are reversible,
|
without risk of the client losing state from a logout. Suspensions are reversible,
|
||||||
like locks and unlike deactivations.
|
like locks and unlike deactivations.
|
||||||
|
|
||||||
|
{{% added-in v="1.18" %}} To suspend or unsuspend an account, administrators
|
||||||
|
SHOULD use the [`PUT /admin/suspend/{userId}`](#put_matrixclientv1adminsuspenduserid)
|
||||||
|
endpoint. They MAY also use [`GET /admin/suspend/{userId}`](#get_matrixclientv1adminsuspenduserid)
|
||||||
|
to check whether a user's account is suspended.
|
||||||
|
|
||||||
The actions a user can perform while suspended is deliberately left as an
|
The actions a user can perform while suspended is deliberately left as an
|
||||||
implementation detail. Servers SHOULD permit the user to perform at least the
|
implementation detail. Servers SHOULD permit the user to perform at least the
|
||||||
following, however:
|
following, however:
|
||||||
|
|
@ -2500,9 +2508,6 @@ Content-Type: application/json
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
APIs for initiating suspension or unsuspension are not included in this version
|
|
||||||
of the specification, and left as an implementation detail.
|
|
||||||
|
|
||||||
### Adding Account Administrative Contact Information
|
### Adding Account Administrative Contact Information
|
||||||
|
|
||||||
A homeserver may keep some contact information for administrative use.
|
A homeserver may keep some contact information for administrative use.
|
||||||
|
|
@ -4071,6 +4076,7 @@ that profile.
|
||||||
| [Sticker Messages](#sticker-messages) | Optional | Optional | Optional | Optional | Optional |
|
| [Sticker Messages](#sticker-messages) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Third-party Networks](#third-party-networks) | Optional | Optional | Optional | Optional | Optional |
|
| [Third-party Networks](#third-party-networks) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Threading](#threading) | Optional | Optional | Optional | Optional | Optional |
|
| [Threading](#threading) | Optional | Optional | Optional | Optional | Optional |
|
||||||
|
| [Invite permission](#invite-permission) | Optional | Optional | Optional | Optional | Optional |
|
||||||
|
|
||||||
*Please see each module for more details on what clients need to
|
*Please see each module for more details on what clients need to
|
||||||
implement.*
|
implement.*
|
||||||
|
|
@ -4144,6 +4150,7 @@ systems.
|
||||||
{{% cs-module name="SSO client login/authentication" filename="sso_login" %}}
|
{{% cs-module name="SSO client login/authentication" filename="sso_login" %}}
|
||||||
{{% cs-module name="Direct Messaging" filename="dm" %}}
|
{{% cs-module name="Direct Messaging" filename="dm" %}}
|
||||||
{{% cs-module name="Ignoring Users" filename="ignore_users" %}}
|
{{% cs-module name="Ignoring Users" filename="ignore_users" %}}
|
||||||
|
{{% cs-module name="Invite permission" filename="invite_permission" %}}
|
||||||
{{% cs-module name="Sticker Messages" filename="stickers" %}}
|
{{% cs-module name="Sticker Messages" filename="stickers" %}}
|
||||||
{{% cs-module name="Reporting Content" filename="report_content" %}}
|
{{% cs-module name="Reporting Content" filename="report_content" %}}
|
||||||
{{% cs-module name="Third-party Networks" filename="third_party_networks" %}}
|
{{% cs-module name="Third-party Networks" filename="third_party_networks" %}}
|
||||||
|
|
|
||||||
|
|
@ -84,6 +84,10 @@ Additionally, web clients should ensure that *all* `a` tags get a
|
||||||
`rel="noopener"` to prevent the target page from referencing the
|
`rel="noopener"` to prevent the target page from referencing the
|
||||||
client's tab/window.
|
client's tab/window.
|
||||||
|
|
||||||
|
{{% added-in v="1.18" %}} Clients that support rendering numbered lists via the
|
||||||
|
`ol` tag MUST also support the `start` attribute in order to prevent loss of
|
||||||
|
meaning of a message due to the numbering of list items.
|
||||||
|
|
||||||
Tags must not be nested more than 100 levels deep. Clients should only
|
Tags must not be nested more than 100 levels deep. Clients should only
|
||||||
support the subset of tags they can render, falling back to other
|
support the subset of tags they can render, falling back to other
|
||||||
representations of the tags where possible. For example, a client may
|
representations of the tags where possible. For example, a client may
|
||||||
|
|
|
||||||
51
content/client-server-api/modules/invite_permission.md
Normal file
51
content/client-server-api/modules/invite_permission.md
Normal file
|
|
@ -0,0 +1,51 @@
|
||||||
|
|
||||||
|
### Invite permission
|
||||||
|
|
||||||
|
{{% added-in v="1.18" %}}
|
||||||
|
|
||||||
|
Users may want to control who is allowed to invite them to new rooms. This module defines how
|
||||||
|
clients and servers can implement invite permission.
|
||||||
|
|
||||||
|
#### Account data
|
||||||
|
|
||||||
|
{{% event event="m.invite_permission_config" %}}
|
||||||
|
|
||||||
|
#### Client behaviour
|
||||||
|
|
||||||
|
To reject invites from all users automatically, clients MAY add an [`m.invite_permission_config`](#minvite_permission_config)
|
||||||
|
event in the user's [account data](#client-config) with the `default_action` property set to
|
||||||
|
`block`. To stop rejecting all invites, the same event without the `default_action` property MUST be
|
||||||
|
added to the account data.
|
||||||
|
|
||||||
|
When the `default_action` field is unset, other parts of the specification might still have effects
|
||||||
|
on invites seen by clients, like [ignoring users](#ignoring-users).
|
||||||
|
|
||||||
|
Attempting to send an invite to a user that blocks invites will result in an error response with the
|
||||||
|
`M_INVITE_BLOCKED` error code.
|
||||||
|
|
||||||
|
#### Server behaviour
|
||||||
|
|
||||||
|
When invites to a given user are blocked, the user's homeserver MUST respond to the following
|
||||||
|
endpoints with an HTTP 403 status code, with the Matrix error code `M_INVITE_BLOCKED`, if the user
|
||||||
|
is invited:
|
||||||
|
|
||||||
|
* [`PUT /_matrix/federation/v1/invite/{roomId}/{eventId}`](/server-server-api/#put_matrixfederationv1inviteroomideventid)
|
||||||
|
* [`PUT /_matrix/federation/v2/invite/{roomId}/{eventId}`](/server-server-api/#put_matrixfederationv2inviteroomideventid)
|
||||||
|
* [`POST /_matrix/client/v3/rooms/{roomId}/invite`](#post_matrixclientv3roomsroomidinvite)
|
||||||
|
* [`POST /_matrix/client/v3/createRoom`](#post_matrixclientv3createroom), due to a user in the
|
||||||
|
`invite` list. It is possible for one of the invited users to be rejected whilst the room creation
|
||||||
|
as a whole succeeds.
|
||||||
|
* [`PUT /_matrix/client/v3/rooms/{roomId}/state/m.room.member/{stateKey}`](#put_matrixclientv3roomsroomidstateeventtypestatekey),
|
||||||
|
when the `membership` is set to `invite`.
|
||||||
|
|
||||||
|
In addition, invite events for this user already in the database, or received over federation, MUST
|
||||||
|
NOT be served over client synchronisation endpoints such as [`GET /sync`](#get_matrixclientv3sync).
|
||||||
|
|
||||||
|
Servers MAY return any suppressed invite events over `GET /sync` if invite blocking is later
|
||||||
|
disabled.
|
||||||
|
|
||||||
|
Other endpoints, such as [`GET /rooms/{roomId}/state`](#get_matrixclientv3roomsroomidstate), are not
|
||||||
|
affected by invite blocking: invite events are returned as normal.
|
||||||
|
|
||||||
|
The Application Services API is also unaffected by invite blocking: invite events are sent over
|
||||||
|
[`PUT /_matrix/app/v1/transactions/{txnId}`](/application-service-api/#put_matrixappv1transactionstxnid).
|
||||||
|
|
@ -43,8 +43,8 @@ They must be explicitly set during the `/upgrade` call.
|
||||||
{{% /boxes/note %}}
|
{{% /boxes/note %}}
|
||||||
|
|
||||||
{{% boxes/note %}}
|
{{% boxes/note %}}
|
||||||
{{% added-in v="1.16" %}} When upgrading to room version 12 or later, the `predecessor` field MAY NOT contain
|
{{% added-in v="1.16" %}} When upgrading to room version 12 or later, the `event_id` property inside
|
||||||
an `event_id`.
|
`predecessor` MAY be omitted.
|
||||||
{{% /boxes/note %}}
|
{{% /boxes/note %}}
|
||||||
|
|
||||||
3. Replicates transferable state events to the new room. The exact
|
3. Replicates transferable state events to the new room. The exact
|
||||||
|
|
|
||||||
|
|
@ -868,8 +868,10 @@ selecting a resident from the candidate list, and using the
|
||||||
enough information for the joining server to fill in the event.
|
enough information for the joining server to fill in the event.
|
||||||
|
|
||||||
The joining server is expected to add or replace the `origin`,
|
The joining server is expected to add or replace the `origin`,
|
||||||
`origin_server_ts`, and `event_id` on the templated event received by
|
`origin_server_ts`, and `event_id` on the templated event received by the
|
||||||
the resident server. This event is then signed by the joining server.
|
resident server. The joining server MUST also verify that the `type`, `room_id`,
|
||||||
|
`sender`, `state_key` and `content.membership` fields have the expected values.
|
||||||
|
This event is then signed by the joining server.
|
||||||
|
|
||||||
To complete the join handshake, the joining server submits this new event
|
To complete the join handshake, the joining server submits this new event
|
||||||
to the resident server it used for `GET /make_join`, using the `PUT /send_join`
|
to the resident server it used for `GET /make_join`, using the `PUT /send_join`
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ info:
|
||||||
title: Matrix Client-Server Administration API
|
title: Matrix Client-Server Administration API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
paths:
|
paths:
|
||||||
"/admin/whois/{userId}":
|
"/v3/admin/whois/{userId}":
|
||||||
get:
|
get:
|
||||||
summary: Gets information about a particular user.
|
summary: Gets information about a particular user.
|
||||||
description: |-
|
description: |-
|
||||||
|
|
@ -107,6 +107,391 @@ paths:
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- Server administration
|
- Server administration
|
||||||
|
"/v1/admin/suspend/{userId}":
|
||||||
|
get:
|
||||||
|
summary: Gets information about the suspended status of a particular user.
|
||||||
|
x-addedInMatrixVersion: "1.18"
|
||||||
|
description: |-
|
||||||
|
Gets information about the suspended status of a particular server-local user.
|
||||||
|
|
||||||
|
The user calling this endpoint MUST be a server admin.
|
||||||
|
|
||||||
|
In order to prevent user enumeration, servers MUST ensure that authorization is checked
|
||||||
|
prior to trying to do account lookups.
|
||||||
|
operationId: getAdminSuspendUser
|
||||||
|
security:
|
||||||
|
- accessTokenQuery: []
|
||||||
|
- accessTokenBearer: []
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: userId
|
||||||
|
description: The user to look up.
|
||||||
|
required: true
|
||||||
|
example: "@peter:rabbit.rocks"
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: mx-user-id
|
||||||
|
pattern: "^@"
|
||||||
|
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The lookup was successful.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
suspended:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the target account is suspended.
|
||||||
|
example: true
|
||||||
|
required:
|
||||||
|
- suspended
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"suspended": true,
|
||||||
|
}
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The user ID does not belong to the local server. The errcode is `M_INVALID_PARAM`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "User does not belong to the local server."
|
||||||
|
}
|
||||||
|
"403":
|
||||||
|
description: |-
|
||||||
|
The requesting user is not a server administrator, or the target user is another
|
||||||
|
administrator. The errcode is `M_FORBIDDEN`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_FORBIDDEN",
|
||||||
|
"error": "Requesting user is not a server administrator."
|
||||||
|
}
|
||||||
|
"404":
|
||||||
|
description: |-
|
||||||
|
The user ID is not found, or is deactivated. The errcode is `M_NOT_FOUND`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_NOT_FOUND",
|
||||||
|
"error": "User not found."
|
||||||
|
}
|
||||||
|
tags:
|
||||||
|
- Server administration
|
||||||
|
put:
|
||||||
|
summary: Set the suspended status of a particular user.
|
||||||
|
x-addedInMatrixVersion: "1.18"
|
||||||
|
description: |-
|
||||||
|
Sets the suspended status of a particular server-local user.
|
||||||
|
|
||||||
|
The user calling this endpoint MUST be a server admin. The client SHOULD check that the user
|
||||||
|
is allowed to suspend other users at the [`GET /capabilities`](/client-server-api/#get_matrixclientv3capabilities)
|
||||||
|
endpoint prior to using this endpoint.
|
||||||
|
|
||||||
|
In order to prevent user enumeration, servers MUST ensure that authorization is checked
|
||||||
|
prior to trying to do account lookups.
|
||||||
|
operationId: setAdminSuspendUser
|
||||||
|
security:
|
||||||
|
- accessTokenQuery: []
|
||||||
|
- accessTokenBearer: []
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: userId
|
||||||
|
description: The user to change the suspended status of.
|
||||||
|
required: true
|
||||||
|
example: "@peter:rabbit.rocks"
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: mx-user-id
|
||||||
|
pattern: "^@"
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
suspended:
|
||||||
|
type: boolean
|
||||||
|
description: Whether to suspend the target account.
|
||||||
|
example: true
|
||||||
|
required:
|
||||||
|
- suspended
|
||||||
|
examples:
|
||||||
|
request:
|
||||||
|
value: {
|
||||||
|
"suspended": true,
|
||||||
|
}
|
||||||
|
required: true
|
||||||
|
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The action was successful.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
suspended:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the target account is suspended.
|
||||||
|
example: true
|
||||||
|
required:
|
||||||
|
- suspended
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"suspended": true,
|
||||||
|
}
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The user ID does not belong to the local server. The errcode is `M_INVALID_PARAM`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "User does not belong to the local server."
|
||||||
|
}
|
||||||
|
"403":
|
||||||
|
description: |-
|
||||||
|
The requesting user is not a server administrator, is trying to suspend their own
|
||||||
|
account, or the target user is another administrator. The errcode is `M_FORBIDDEN`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_FORBIDDEN",
|
||||||
|
"error": "Requesting user is not a server administrator."
|
||||||
|
}
|
||||||
|
"404":
|
||||||
|
description: |-
|
||||||
|
The user ID is not found, or is deactivated. The errcode is `M_NOT_FOUND`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_NOT_FOUND",
|
||||||
|
"error": "User not found."
|
||||||
|
}
|
||||||
|
tags:
|
||||||
|
- Server administration
|
||||||
|
"/v1/admin/lock/{userId}":
|
||||||
|
get:
|
||||||
|
summary: Gets information about the locked status of a particular user.
|
||||||
|
x-addedInMatrixVersion: "1.18"
|
||||||
|
description: |-
|
||||||
|
Gets information about the locked status of a particular server-local user.
|
||||||
|
|
||||||
|
The user calling this endpoint MUST be a server admin.
|
||||||
|
|
||||||
|
In order to prevent user enumeration, servers MUST ensure that authorization is checked
|
||||||
|
prior to trying to do account lookups.
|
||||||
|
operationId: getAdminLockUser
|
||||||
|
security:
|
||||||
|
- accessTokenQuery: []
|
||||||
|
- accessTokenBearer: []
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: userId
|
||||||
|
description: The user to look up.
|
||||||
|
required: true
|
||||||
|
example: "@peter:rabbit.rocks"
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: mx-user-id
|
||||||
|
pattern: "^@"
|
||||||
|
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The lookup was successful.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
locked:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the target account is locked.
|
||||||
|
required:
|
||||||
|
- locked
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"locked": true,
|
||||||
|
}
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The user ID does not belong to the local server. The errcode is `M_INVALID_PARAM`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "User does not belong to the local server."
|
||||||
|
}
|
||||||
|
"403":
|
||||||
|
description: |-
|
||||||
|
The requesting user is not a server administrator, or the target user is another
|
||||||
|
administrator. The errcode is `M_FORBIDDEN`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_FORBIDDEN",
|
||||||
|
"error": "Requesting user is not a server administrator."
|
||||||
|
}
|
||||||
|
"404":
|
||||||
|
description: |-
|
||||||
|
The user ID is not found, or is deactivated. The errcode is `M_NOT_FOUND`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_NOT_FOUND",
|
||||||
|
"error": "User not found."
|
||||||
|
}
|
||||||
|
tags:
|
||||||
|
- Server administration
|
||||||
|
put:
|
||||||
|
summary: Set the locked status of a particular user.
|
||||||
|
x-addedInMatrixVersion: "1.18"
|
||||||
|
description: |-
|
||||||
|
Sets the locked status of a particular server-local user.
|
||||||
|
|
||||||
|
The user calling this endpoint MUST be a server admin. The client SHOULD check that the user
|
||||||
|
is allowed to lock other users at the [`GET /capabilities`](/client-server-api/#get_matrixclientv3capabilities)
|
||||||
|
endpoint prior to using this endpoint.
|
||||||
|
|
||||||
|
In order to prevent user enumeration, servers MUST ensure that authorization is checked
|
||||||
|
prior to trying to do account lookups.
|
||||||
|
operationId: setAdminLockUser
|
||||||
|
security:
|
||||||
|
- accessTokenQuery: []
|
||||||
|
- accessTokenBearer: []
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: userId
|
||||||
|
description: The user to change the locked status of.
|
||||||
|
required: true
|
||||||
|
example: "@peter:rabbit.rocks"
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: mx-user-id
|
||||||
|
pattern: "^@"
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
locked:
|
||||||
|
type: boolean
|
||||||
|
description: Whether to lock the target account.
|
||||||
|
example: true
|
||||||
|
required:
|
||||||
|
- locked
|
||||||
|
examples:
|
||||||
|
request:
|
||||||
|
value: {
|
||||||
|
"locked": true,
|
||||||
|
}
|
||||||
|
required: true
|
||||||
|
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: The action was successful.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
locked:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the target account is locked.
|
||||||
|
example: true
|
||||||
|
required:
|
||||||
|
- locked
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"locked": true,
|
||||||
|
}
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The user ID does not belong to the local server. The errcode is `M_INVALID_PARAM`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "User does not belong to the local server."
|
||||||
|
}
|
||||||
|
"403":
|
||||||
|
description: |-
|
||||||
|
The requesting user is not a server administrator, is trying to lock their own
|
||||||
|
account, or the target user is another administrator. The errcode is `M_FORBIDDEN`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_FORBIDDEN",
|
||||||
|
"error": "Requesting user is not a server administrator."
|
||||||
|
}
|
||||||
|
"404":
|
||||||
|
description: |-
|
||||||
|
The user ID is not found, or is deactivated. The errcode is `M_NOT_FOUND`.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_NOT_FOUND",
|
||||||
|
"error": "User not found."
|
||||||
|
}
|
||||||
|
tags:
|
||||||
|
- Server administration
|
||||||
servers:
|
servers:
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
- url: "{protocol}://{hostname}{basePath}"
|
||||||
variables:
|
variables:
|
||||||
|
|
@ -118,7 +503,7 @@ servers:
|
||||||
hostname:
|
hostname:
|
||||||
default: localhost:8008
|
default: localhost:8008
|
||||||
basePath:
|
basePath:
|
||||||
default: /_matrix/client/v3
|
default: /_matrix/client
|
||||||
components:
|
components:
|
||||||
securitySchemes:
|
securitySchemes:
|
||||||
accessTokenQuery:
|
accessTokenQuery:
|
||||||
|
|
|
||||||
|
|
@ -147,6 +147,34 @@ paths:
|
||||||
example: true
|
example: true
|
||||||
required:
|
required:
|
||||||
- enabled
|
- enabled
|
||||||
|
m.account_moderation:
|
||||||
|
x-addedInMatrixVersion: "1.18"
|
||||||
|
type: object
|
||||||
|
title: AccountModerationCapability
|
||||||
|
description: |-
|
||||||
|
Capability to indicate if the user can perform account moderation actions
|
||||||
|
via [server administration](/client-server-api/#server-administration)
|
||||||
|
endpoints.
|
||||||
|
|
||||||
|
This property should be omitted altogether if `suspend` and `lock` would
|
||||||
|
be `false`.
|
||||||
|
properties:
|
||||||
|
suspend:
|
||||||
|
type: boolean
|
||||||
|
description: |-
|
||||||
|
`true` if the user can suspend a user via [`PUT /admin/suspend/{userId}`](/client-server-api/#put_matrixclientv1adminsuspenduserid),
|
||||||
|
`false` otherwise.
|
||||||
|
|
||||||
|
Defaults to `false`.
|
||||||
|
example: true
|
||||||
|
lock:
|
||||||
|
type: boolean
|
||||||
|
description: |-
|
||||||
|
`true` if the user can lock a user via [`PUT /admin/lock/{userId}`](/client-server-api/#put_matrixclientv1adminlockuserid),
|
||||||
|
`false` otherwise.
|
||||||
|
|
||||||
|
Defaults to `false`.
|
||||||
|
example: true
|
||||||
examples:
|
examples:
|
||||||
response:
|
response:
|
||||||
value: {
|
value: {
|
||||||
|
|
|
||||||
|
|
@ -250,7 +250,6 @@ paths:
|
||||||
}
|
}
|
||||||
"400":
|
"400":
|
||||||
description: |-
|
description: |-
|
||||||
|
|
||||||
The request is invalid. A meaningful `errcode` and description
|
The request is invalid. A meaningful `errcode` and description
|
||||||
error text will be returned. Example reasons for rejection include:
|
error text will be returned. Example reasons for rejection include:
|
||||||
|
|
||||||
|
|
@ -274,6 +273,17 @@ paths:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: definitions/errors/error.yaml
|
$ref: definitions/errors/error.yaml
|
||||||
|
"403":
|
||||||
|
description: |-
|
||||||
|
Creating the room is not allowed.
|
||||||
|
|
||||||
|
{{% added-in v="1.18"%}} The `M_INVITE_BLOCKED` error code is used to
|
||||||
|
indicate that one of the homeservers of the invited users rejected
|
||||||
|
the invite due to [invite blocking](/client-server-api/#invite-permission).
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: definitions/errors/error.yaml
|
||||||
tags:
|
tags:
|
||||||
- Room creation
|
- Room creation
|
||||||
servers:
|
servers:
|
||||||
|
|
|
||||||
|
|
@ -99,12 +99,18 @@ paths:
|
||||||
$ref: definitions/errors/error.yaml
|
$ref: definitions/errors/error.yaml
|
||||||
"403":
|
"403":
|
||||||
description: |-
|
description: |-
|
||||||
You do not have permission to invite the user to the room. A meaningful `errcode` and description error text will be returned. Example reasons for rejections are:
|
You do not have permission to invite the user to the room. A
|
||||||
|
meaningful `errcode` and description error text will be returned.
|
||||||
|
Example reasons for rejections are:
|
||||||
|
|
||||||
- The invitee has been banned from the room.
|
- The invitee has been banned from the room.
|
||||||
- The invitee is already a member of the room.
|
- The invitee is already a member of the room.
|
||||||
- The inviter is not currently in the room.
|
- The inviter is not currently in the room.
|
||||||
- The inviter's power level is insufficient to invite users to the room.
|
- The inviter's power level is insufficient to invite users to the room.
|
||||||
|
|
||||||
|
{{% added-in v="1.18"%}} The `M_INVITE_BLOCKED` error code is used to
|
||||||
|
indicate that the homeserver rejected the invite due to
|
||||||
|
[invite blocking](/client-server-api/#invite-permission).
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
|
||||||
|
|
@ -116,7 +116,13 @@ paths:
|
||||||
"error": "The alias '#hello:example.org' does not point to this room."
|
"error": "The alias '#hello:example.org' does not point to this room."
|
||||||
}
|
}
|
||||||
"403":
|
"403":
|
||||||
description: The sender doesn't have permission to send the event into the room.
|
description: |-
|
||||||
|
The sender doesn't have permission to send the event into the room.
|
||||||
|
|
||||||
|
{{% added-in v="1.18"%}} If the `eventType` is `m.room.member` and
|
||||||
|
the `membership` is `invite`, the `M_INVITE_BLOCKED` error code is
|
||||||
|
used to indicate that the homeserver rejected the invite due to
|
||||||
|
[invite blocking](/client-server-api/#invite-permission).
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
|
||||||
|
|
@ -97,6 +97,10 @@ paths:
|
||||||
- The invitee is already a member of the room.
|
- The invitee is already a member of the room.
|
||||||
- The inviter is not currently in the room.
|
- The inviter is not currently in the room.
|
||||||
- The inviter's power level is insufficient to invite users to the room.
|
- The inviter's power level is insufficient to invite users to the room.
|
||||||
|
|
||||||
|
{{% added-in v="1.18"%}} The `M_INVITE_BLOCKED` error code is used to
|
||||||
|
indicate that the homeserver rejected the invite due to
|
||||||
|
[invite blocking](/client-server-api/#invite-permission).
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
|
||||||
|
|
@ -36,6 +36,28 @@ paths:
|
||||||
Also note that if the remote homeserver is already in the room, it will receive the
|
Also note that if the remote homeserver is already in the room, it will receive the
|
||||||
invite event twice; once through this endpoint, and again through a [federation
|
invite event twice; once through this endpoint, and again through a [federation
|
||||||
transaction](/server-server-api/#transactions).
|
transaction](/server-server-api/#transactions).
|
||||||
|
|
||||||
|
Servers MUST apply certain validation to ensure they don't accidentally sign non-invite
|
||||||
|
events from a malicious server. A specific error code is not mandated, but servers SHOULD
|
||||||
|
return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The invite event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* The event type is not `m.room.member`.
|
||||||
|
* The `membership` field inside the event content is not `invite`.
|
||||||
|
* The event sender is not a user ID on the origin server.
|
||||||
|
* The `state_key` is not a user ID on the receiving server.
|
||||||
|
|
||||||
|
The `invite_room_state` has additional validation, which servers MAY apply to room versions
|
||||||
|
1 through 11 and SHOULD apply to all other room versions. As with the above errors, servers
|
||||||
|
SHOULD return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The `m.room.create` event is missing from `invite_room_state`.
|
||||||
|
* One or more entries in `invite_room_state` are not formatted according
|
||||||
|
to the room's version.
|
||||||
|
* One or more events fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* One or more events does not reside in the same room as the invite.
|
||||||
|
Note: Some room versions may require calculating the room ID for an
|
||||||
|
event rather than relying on the presence of `room_id`.
|
||||||
operationId: sendInviteV1
|
operationId: sendInviteV1
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -83,8 +105,7 @@ paths:
|
||||||
MUST additionally be formatted according to the room version specification.
|
MUST additionally be formatted according to the room version specification.
|
||||||
|
|
||||||
Servers might need to apply validation to the `invite_room_state` depending
|
Servers might need to apply validation to the `invite_room_state` depending
|
||||||
on room version. See the `400 M_MISSING_PARAM` error definition for more
|
on room version. See endpoint description for more information.
|
||||||
information.
|
|
||||||
|
|
||||||
Note that events have a different format depending on the room
|
Note that events have a different format depending on the room
|
||||||
version - check the [room version specification](/rooms) for
|
version - check the [room version specification](/rooms) for
|
||||||
|
|
@ -155,11 +176,17 @@ paths:
|
||||||
]
|
]
|
||||||
"403":
|
"403":
|
||||||
description: |-
|
description: |-
|
||||||
The invite is not allowed. This could be for a number of reasons, including:
|
The invite is not allowed.
|
||||||
|
|
||||||
|
The `M_FORBIDDEN` error code is used to indicate one of the following:
|
||||||
|
|
||||||
* The sender is not allowed to send invites to the target user/homeserver.
|
* The sender is not allowed to send invites to the target user/homeserver.
|
||||||
* The homeserver does not permit anyone to invite its users.
|
* The homeserver does not permit anyone to invite its users.
|
||||||
* The homeserver refuses to participate in the room.
|
* The homeserver refuses to participate in the room.
|
||||||
|
|
||||||
|
{{% added-in v="1.18"%}} The `M_INVITE_BLOCKED` error code is used to
|
||||||
|
indicate that the homeserver rejected the invite due to
|
||||||
|
[invite blocking](/client-server-api/#invite-permission).
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -172,23 +199,7 @@ paths:
|
||||||
}
|
}
|
||||||
"400":
|
"400":
|
||||||
description: |-
|
description: |-
|
||||||
The `M_MISSING_PARAM` error code is used to indicate one or more of
|
The request is invalid in some way.
|
||||||
the following:
|
|
||||||
|
|
||||||
* The `m.room.create` event is missing from `invite_room_state`.
|
|
||||||
* One or more entries in `invite_room_state` are not formatted according
|
|
||||||
to the room's version.
|
|
||||||
* One or more events fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
|
||||||
* One or more events does not reside in the same room as the invite.
|
|
||||||
Note: Some room versions may require calculating the room ID for an
|
|
||||||
event rather than relying on the presence of `room_id`.
|
|
||||||
|
|
||||||
Servers MAY apply the validation above to room versions 1 through 11,
|
|
||||||
and SHOULD apply the validation above to all other room versions.
|
|
||||||
|
|
||||||
If `M_MISSING_PARAM` is returned and the request is associated with a
|
|
||||||
Client-Server API request, the Client-Server API request SHOULD fail
|
|
||||||
with a 5xx error rather than being passed through.
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -196,7 +207,7 @@ paths:
|
||||||
examples:
|
examples:
|
||||||
response:
|
response:
|
||||||
value: {
|
value: {
|
||||||
"errcode": "M_MISSING_PARAM",
|
"errcode": "M_INVALID_PARAM",
|
||||||
"error": "Create event not among invite state entries."
|
"error": "Create event not among invite state entries."
|
||||||
}
|
}
|
||||||
servers:
|
servers:
|
||||||
|
|
|
||||||
|
|
@ -40,6 +40,28 @@ paths:
|
||||||
Also note that if the remote homeserver is already in the room, it will receive the
|
Also note that if the remote homeserver is already in the room, it will receive the
|
||||||
invite event twice; once through this endpoint, and again through a [federation
|
invite event twice; once through this endpoint, and again through a [federation
|
||||||
transaction](/server-server-api/#transactions).
|
transaction](/server-server-api/#transactions).
|
||||||
|
|
||||||
|
Servers MUST apply certain validation to ensure they don't accidentally sign non-invite
|
||||||
|
events from a malicious server. A specific error code is not mandated, but servers SHOULD
|
||||||
|
return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The invite event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* The event type is not `m.room.member`.
|
||||||
|
* The `membership` field inside the event content is not `invite`.
|
||||||
|
* The event sender is not a user ID on the origin server.
|
||||||
|
* The `state_key` is not a user ID on the receiving server.
|
||||||
|
|
||||||
|
The `invite_room_state` has additional validation, which servers MAY apply to room versions
|
||||||
|
1 through 11 and SHOULD apply to all other room versions. As with the above errors, servers
|
||||||
|
SHOULD return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The `m.room.create` event is missing from `invite_room_state`.
|
||||||
|
* One or more entries in `invite_room_state` are not formatted according
|
||||||
|
to the room's version.
|
||||||
|
* One or more events fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* One or more events does not reside in the same room as the invite.
|
||||||
|
Note: Some room versions may require calculating the room ID for an
|
||||||
|
event rather than relying on the presence of `room_id`.
|
||||||
operationId: sendInviteV2
|
operationId: sendInviteV2
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -84,8 +106,7 @@ paths:
|
||||||
MUST additionally be formatted according to the room version specification.
|
MUST additionally be formatted according to the room version specification.
|
||||||
|
|
||||||
Servers might need to apply validation to the `invite_room_state` depending
|
Servers might need to apply validation to the `invite_room_state` depending
|
||||||
on room version. See the `400 M_MISSING_PARAM` error definition for more
|
on room version. See the endpoint description for more information.
|
||||||
information.
|
|
||||||
|
|
||||||
Note that events have a different format depending on the room
|
Note that events have a different format depending on the room
|
||||||
version - check the [room version specification](/rooms) for
|
version - check the [room version specification](/rooms) for
|
||||||
|
|
@ -154,22 +175,8 @@ paths:
|
||||||
The error should be passed through to clients so that they
|
The error should be passed through to clients so that they
|
||||||
may give better feedback to users.
|
may give better feedback to users.
|
||||||
|
|
||||||
The `M_MISSING_PARAM` error code is used to indicate one or more of
|
If `M_MISSING_PARAM` or `M_INVALID_PARAM` is returned and the request is associated
|
||||||
the following:
|
with a Client-Server API request, the Client-Server API request SHOULD fail
|
||||||
|
|
||||||
* The `m.room.create` event is missing from `invite_room_state`.
|
|
||||||
* One or more entries in `invite_room_state` are not formatted according
|
|
||||||
to the room's version.
|
|
||||||
* One or more events fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
|
||||||
* One or more events does not reside in the same room as the invite.
|
|
||||||
Note: Some room versions may require calculating the room ID for an
|
|
||||||
event rather than relying on the presence of `room_id`.
|
|
||||||
|
|
||||||
Servers MAY apply the validation above to room versions 1 through 11,
|
|
||||||
and SHOULD apply the validation above to all other room versions.
|
|
||||||
|
|
||||||
If `M_MISSING_PARAM` is returned and the request is associated with a
|
|
||||||
Client-Server API request, the Client-Server API request SHOULD fail
|
|
||||||
with a 5xx error rather than being passed through.
|
with a 5xx error rather than being passed through.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
|
|
@ -192,11 +199,17 @@ paths:
|
||||||
}
|
}
|
||||||
"403":
|
"403":
|
||||||
description: |-
|
description: |-
|
||||||
The invite is not allowed. This could be for a number of reasons, including:
|
The invite is not allowed.
|
||||||
|
|
||||||
|
The `M_FORBIDDEN` error code is used to indicate one of the following:
|
||||||
|
|
||||||
* The sender is not allowed to send invites to the target user/homeserver.
|
* The sender is not allowed to send invites to the target user/homeserver.
|
||||||
* The homeserver does not permit anyone to invite its users.
|
* The homeserver does not permit anyone to invite its users.
|
||||||
* The homeserver refuses to participate in the room.
|
* The homeserver refuses to participate in the room.
|
||||||
|
|
||||||
|
{{% added-in v="1.18"%}} The `M_INVITE_BLOCKED` error code is used to
|
||||||
|
indicate that the homeserver rejected the invite due to
|
||||||
|
[invite blocking](/client-server-api/#invite-permission).
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
|
||||||
|
|
@ -23,6 +23,17 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
Asks the receiving server to return information that the sending
|
Asks the receiving server to return information that the sending
|
||||||
server will need to prepare a join event to get into the room.
|
server will need to prepare a join event to get into the room.
|
||||||
|
|
||||||
|
Before signing the returned template and calling `/send_join`,
|
||||||
|
the sending server MUST verify that:
|
||||||
|
|
||||||
|
* the `room_id` is equal to the `roomId` path parameter.
|
||||||
|
* both the `sender` and `state_key` are equal to the `userId` path parameter.
|
||||||
|
* the `type` of the event is `m.room.member`.
|
||||||
|
* the `membership` field inside `content` is `join`.
|
||||||
|
|
||||||
|
In case any of the above checks fail, the response MUST be treated as malformed and
|
||||||
|
discarded. The caller MAY try to join through another server.
|
||||||
operationId: makeJoin
|
operationId: makeJoin
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -36,7 +47,7 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
- in: path
|
- in: path
|
||||||
name: userId
|
name: userId
|
||||||
description: The user ID the join event will be for.
|
description: The user ID the join event will be for. This MUST be a user ID on the origin server.
|
||||||
required: true
|
required: true
|
||||||
example: "@someone:example.org"
|
example: "@someone:example.org"
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -238,6 +249,15 @@ paths:
|
||||||
**The request and response body here describe the common
|
**The request and response body here describe the common
|
||||||
event fields in more detail and may be missing other required
|
event fields in more detail and may be missing other required
|
||||||
fields for a PDU.**
|
fields for a PDU.**
|
||||||
|
|
||||||
|
The receiving server MUST apply certain validation before accepting the event.
|
||||||
|
A specific error code is not mandated, but servers SHOULD return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The join event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* The event type is not `m.room.member`.
|
||||||
|
* The `membership` field inside the event content is not `join`.
|
||||||
|
* The event sender is not a user ID on the origin server.
|
||||||
|
* The `state_key` is not equal to the `sender`.
|
||||||
operationId: sendJoinV1
|
operationId: sendJoinV1
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -388,6 +408,33 @@ paths:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The request is invalid in some way.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../client-server/definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "Not a join event."
|
||||||
|
}
|
||||||
|
"403":
|
||||||
|
description: |-
|
||||||
|
The room that the joining server is attempting to join does not permit the user
|
||||||
|
to join.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../client-server/definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_FORBIDDEN",
|
||||||
|
"error": "You are not invited to this room"
|
||||||
|
}
|
||||||
servers:
|
servers:
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
- url: "{protocol}://{hostname}{basePath}"
|
||||||
variables:
|
variables:
|
||||||
|
|
|
||||||
|
|
@ -38,6 +38,15 @@ paths:
|
||||||
**The request and response body here describe the common
|
**The request and response body here describe the common
|
||||||
event fields in more detail and may be missing other required
|
event fields in more detail and may be missing other required
|
||||||
fields for a PDU.**
|
fields for a PDU.**
|
||||||
|
|
||||||
|
The receiving server MUST apply certain validation before accepting the event.
|
||||||
|
A specific error code is not mandated, but servers SHOULD return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The join event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* The event type is not `m.room.member`.
|
||||||
|
* The `membership` field inside the event content is not `join`.
|
||||||
|
* The event sender is not a user ID on the origin server.
|
||||||
|
* The `state_key` is not equal to the `sender`.
|
||||||
operationId: sendJoinV2
|
operationId: sendJoinV2
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -247,6 +256,10 @@ paths:
|
||||||
The error should be passed through to clients so that they
|
The error should be passed through to clients so that they
|
||||||
may give better feedback to users.
|
may give better feedback to users.
|
||||||
|
|
||||||
|
If `M_MISSING_PARAM` or `M_INVALID_PARAM` is returned and the request is associated
|
||||||
|
with a Client-Server API request, the Client-Server API request SHOULD fail
|
||||||
|
with a 5xx error rather than being passed through.
|
||||||
|
|
||||||
New in `v1.2`, the following error conditions might happen:
|
New in `v1.2`, the following error conditions might happen:
|
||||||
|
|
||||||
If the room is [restricted](/client-server-api/#restricted-rooms)
|
If the room is [restricted](/client-server-api/#restricted-rooms)
|
||||||
|
|
|
||||||
|
|
@ -34,10 +34,10 @@ paths:
|
||||||
- in: query
|
- in: query
|
||||||
name: minimum_valid_until_ts
|
name: minimum_valid_until_ts
|
||||||
description: |-
|
description: |-
|
||||||
A millisecond POSIX timestamp in milliseconds indicating when the returned
|
A millisecond POSIX timestamp. The returned keys SHOULD be valid
|
||||||
certificates will need to be valid until to be useful to the requesting server.
|
until at least this timestamp.
|
||||||
|
|
||||||
If not supplied, the current time as determined by the notary server is used.
|
If not supplied, the notary server MUST use the current time.
|
||||||
required: false
|
required: false
|
||||||
example: 1234567890
|
example: 1234567890
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -98,12 +98,11 @@ paths:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
description: |-
|
description: |-
|
||||||
A millisecond POSIX timestamp in milliseconds indicating when
|
A millisecond POSIX timestamp. The returned keys
|
||||||
the returned certificates will need to be valid until to be
|
SHOULD be valid until at least this timestamp.
|
||||||
useful to the requesting server.
|
|
||||||
|
|
||||||
If not supplied, the current time as determined by the notary
|
If not supplied, the notary server MUST use the
|
||||||
server is used.
|
current time.
|
||||||
example: 1234567890
|
example: 1234567890
|
||||||
required:
|
required:
|
||||||
- server_keys
|
- server_keys
|
||||||
|
|
|
||||||
|
|
@ -23,6 +23,17 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
Asks the receiving server to return information that the sending
|
Asks the receiving server to return information that the sending
|
||||||
server will need to prepare a knock event for the room.
|
server will need to prepare a knock event for the room.
|
||||||
|
|
||||||
|
Before signing the returned template and calling `/send_knock`,
|
||||||
|
the sending server MUST verify that:
|
||||||
|
|
||||||
|
* the `room_id` is equal to the `roomId` path parameter.
|
||||||
|
* both the `sender` and `state_key` are equal to the `userId` path parameter.
|
||||||
|
* the `type` of the event is `m.room.member`.
|
||||||
|
* the `membership` field inside `content` is `knock`.
|
||||||
|
|
||||||
|
In case any of the above checks fail, the response MUST be treated as malformed and
|
||||||
|
discarded. The caller MAY try to knock through another server.
|
||||||
operationId: makeKnock
|
operationId: makeKnock
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -36,7 +47,7 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
- in: path
|
- in: path
|
||||||
name: userId
|
name: userId
|
||||||
description: The user ID the knock event will be for.
|
description: The user ID the knock event will be for. This MUST be a user ID on the origin server.
|
||||||
required: true
|
required: true
|
||||||
example: "@someone:example.org"
|
example: "@someone:example.org"
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -204,6 +215,15 @@ paths:
|
||||||
**The request and response body here describe the common
|
**The request and response body here describe the common
|
||||||
event fields in more detail and may be missing other required
|
event fields in more detail and may be missing other required
|
||||||
fields for a PDU.**
|
fields for a PDU.**
|
||||||
|
|
||||||
|
The receiving server MUST apply certain validation before accepting the event.
|
||||||
|
A specific error code is not mandated, but servers SHOULD return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The knock event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* The event type is not `m.room.member`.
|
||||||
|
* The `membership` field inside the event content is not `knock`.
|
||||||
|
* The event sender is not a user ID on the origin server.
|
||||||
|
* The `state_key` is not equal to the `sender`.
|
||||||
operationId: sendKnock
|
operationId: sendKnock
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -330,6 +350,19 @@ paths:
|
||||||
"$ref": "./examples/invite_or_knock_state.json"
|
"$ref": "./examples/invite_or_knock_state.json"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The request is invalid in some way.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../client-server/definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "Not a knock event."
|
||||||
|
}
|
||||||
"403":
|
"403":
|
||||||
description: |-
|
description: |-
|
||||||
The knocking server or user is not permitted to knock on the room, such as when the
|
The knocking server or user is not permitted to knock on the room, such as when the
|
||||||
|
|
|
||||||
|
|
@ -23,6 +23,17 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
Asks the receiving server to return information that the sending
|
Asks the receiving server to return information that the sending
|
||||||
server will need to prepare a leave event to get out of the room.
|
server will need to prepare a leave event to get out of the room.
|
||||||
|
|
||||||
|
Before signing the returned template and calling `/send_leave`,
|
||||||
|
the sending server MUST verify that:
|
||||||
|
|
||||||
|
* the `room_id` is equal to the `roomId` path parameter.
|
||||||
|
* both the `sender` and `state_key` are equal to the `userId` path parameter.
|
||||||
|
* the `type` of the event is `m.room.member`.
|
||||||
|
* the `membership` field inside `content` is `leave`.
|
||||||
|
|
||||||
|
In case any of the above checks fail, the response MUST be treated as malformed and
|
||||||
|
discarded. The caller MAY try to leave through another server.
|
||||||
operationId: makeLeave
|
operationId: makeLeave
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -36,7 +47,7 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
- in: path
|
- in: path
|
||||||
name: userId
|
name: userId
|
||||||
description: The user ID the leave event will be for.
|
description: The user ID the leave event will be for. This MUST be a user ID on the origin server.
|
||||||
required: true
|
required: true
|
||||||
example: "@someone:example.org"
|
example: "@someone:example.org"
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -153,6 +164,15 @@ paths:
|
||||||
**The request and response body here describe the common
|
**The request and response body here describe the common
|
||||||
event fields in more detail and may be missing other required
|
event fields in more detail and may be missing other required
|
||||||
fields for a PDU.**
|
fields for a PDU.**
|
||||||
|
|
||||||
|
The receiving server MUST apply certain validation before accepting the event.
|
||||||
|
A specific error code is not mandated, but servers SHOULD return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The leave event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* The event type is not `m.room.member`.
|
||||||
|
* The `membership` field inside the event content is not `leave`.
|
||||||
|
* The event sender is not a user ID on the origin server.
|
||||||
|
* The `state_key` is not equal to the `sender`.
|
||||||
operationId: sendLeaveV1
|
operationId: sendLeaveV1
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -249,6 +269,19 @@ paths:
|
||||||
200,
|
200,
|
||||||
{}
|
{}
|
||||||
]
|
]
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The request is invalid in some way.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../client-server/definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "Not a leave event."
|
||||||
|
}
|
||||||
servers:
|
servers:
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
- url: "{protocol}://{hostname}{basePath}"
|
||||||
variables:
|
variables:
|
||||||
|
|
|
||||||
|
|
@ -38,6 +38,15 @@ paths:
|
||||||
**The request and response body here describe the common
|
**The request and response body here describe the common
|
||||||
event fields in more detail and may be missing other required
|
event fields in more detail and may be missing other required
|
||||||
fields for a PDU.**
|
fields for a PDU.**
|
||||||
|
|
||||||
|
The receiving server MUST apply certain validation before accepting the event.
|
||||||
|
A specific error code is not mandated, but servers SHOULD return `M_INVALID_PARAM` if:
|
||||||
|
|
||||||
|
* The leave event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||||
|
* The event type is not `m.room.member`.
|
||||||
|
* The `membership` field inside the event content is not `leave`.
|
||||||
|
* The event sender is not a user ID on the origin server.
|
||||||
|
* The `state_key` is not equal to the `sender`.
|
||||||
operationId: sendLeaveV2
|
operationId: sendLeaveV2
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -134,6 +143,19 @@ paths:
|
||||||
examples:
|
examples:
|
||||||
response:
|
response:
|
||||||
value: {}
|
value: {}
|
||||||
|
"400":
|
||||||
|
description: |-
|
||||||
|
The request is invalid in some way.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../client-server/definitions/errors/error.yaml
|
||||||
|
examples:
|
||||||
|
response:
|
||||||
|
value: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "Not a leave event."
|
||||||
|
}
|
||||||
servers:
|
servers:
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
- url: "{protocol}://{hostname}{basePath}"
|
||||||
variables:
|
variables:
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,7 @@
|
||||||
|
{
|
||||||
|
"$ref": "core/event.json",
|
||||||
|
"type": "m.invite_permission_config",
|
||||||
|
"content": {
|
||||||
|
"default_action": "block"
|
||||||
|
}
|
||||||
|
}
|
||||||
21
data/event-schemas/schema/m.invite_permission_config.yaml
Normal file
21
data/event-schemas/schema/m.invite_permission_config.yaml
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
---
|
||||||
|
$schema: https://json-schema.org/draft/2020-12/schema
|
||||||
|
allOf:
|
||||||
|
- $ref: core-event-schema/event.yaml
|
||||||
|
- title: Invite Permission
|
||||||
|
type: object
|
||||||
|
description: |-
|
||||||
|
The permission configuration for receiving invites for the current account.
|
||||||
|
properties:
|
||||||
|
content:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
default_action:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
When set to `block`, the user does not wish to receive *any* room invites, and they
|
||||||
|
should be rejected automatically by the homeserver.
|
||||||
|
|
||||||
|
A missing, invalid or unsupported value means that the user wants to receive invites
|
||||||
|
as normal. Other parts of the specification might still have effects on invites, like
|
||||||
|
[ignoring users](/client-server-api/#ignoring-users).
|
||||||
Loading…
Reference in a new issue