Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 19:44:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add more variants of the security schemes for the client-server API

Browse source 
Adds the `Authorization: Bearer` possibility.
Also clarifies on two endpoints that only an appservice access token can be used.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2024-03-29 11:04:49 +01:00
parent 8ff3623e37
commit ae4e8375c6
No known key found for this signature in database
GPG key ID: 29A48C1F03620416
60 changed files with 280 additions and 133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
data/api/client-server/account-data.yaml
View file

@ -26,7 +26,8 @@ paths:
[/sync](#get_matrixclientv3sync). [/sync](#get_matrixclientv3sync).
operationId: setAccountData operationId: setAccountData
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -117,7 +118,8 @@ paths:
that set the account data. that set the account data.
operationId: getAccountData operationId: getAccountData
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -186,7 +188,8 @@ paths:
clients in the per-room entries via [/sync](#get_matrixclientv3sync). clients in the per-room entries via [/sync](#get_matrixclientv3sync).
operationId: setAccountDataPerRoom operationId: setAccountDataPerRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -285,7 +288,8 @@ paths:
visible to the user that set the account data. visible to the user that set the account data.
operationId: getAccountDataPerRoom operationId: getAccountDataPerRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

3
data/api/client-server/admin.yaml
View file

@ -27,7 +27,8 @@ paths:
specified in this document. specified in this document.
operationId: getWhoIs operationId: getWhoIs
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

18
data/api/client-server/administrative_contact.yaml
View file

@ -31,7 +31,8 @@ paths:
identifiers that it will accept to reset the user's account password. identifiers that it will accept to reset the user's account password.
operationId: getAccount3PIDs operationId: getAccount3PIDs
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The lookup was successful. description: The lookup was successful.
@ -101,7 +102,8 @@ paths:
operationId: post3PIDs operationId: post3PIDs
deprecated: true deprecated: true
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -201,7 +203,8 @@ paths:
already been added to another user's account on the homeserver. already been added to another user's account on the homeserver.
operationId: add3PID operationId: add3PID
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -263,7 +266,8 @@ paths:
Homeservers should track successful binds so they can be unbound later. Homeservers should track successful binds so they can be unbound later.
operationId: bind3PID operationId: bind3PID
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -324,7 +328,8 @@ paths:
identity server instead. identity server instead.
operationId: delete3pidFromAccount operationId: delete3pidFromAccount
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -393,7 +398,8 @@ paths:
identity server instead. identity server instead.
operationId: unbind3pidFromAccount operationId: unbind3pidFromAccount
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:

6
data/api/client-server/appservice_ping.yaml
View file

@ -57,8 +57,8 @@ paths:
example: mautrix-go_1683636478256400935_123 example: mautrix-go_1683636478256400935_123
required: true required: true
security: security:
# again, this is the appservice's token - not a typical client's - appserviceAccessTokenQuery: []
- accessToken: [] - appserviceAccessTokenBearer: []
responses: responses:
"200": "200":
description: The ping was successful. description: The ping was successful.
@ -177,6 +177,4 @@ servers:
default: /_matrix/client/v1 default: /_matrix/client/v1
components: components:
securitySchemes: securitySchemes:
# Note: this is the same access_token definition used elsewhere in the client
# server API, however this expects an access token for an application service.
$ref: definitions/security.yaml $ref: definitions/security.yaml

6
data/api/client-server/appservice_room_directory.yaml
View file

@ -67,8 +67,8 @@ paths:
- visibility - visibility
required: true required: true
security: security:
# again, this is the appservice's token - not a typical client's - appserviceAccessTokenQuery: []
- accessToken: [] - appserviceAccessTokenBearer: []
responses: responses:
"200": "200":
description: The room's directory visibility has been updated. description: The room's directory visibility has been updated.
@ -95,6 +95,4 @@ servers:
default: /_matrix/client/v3 default: /_matrix/client/v3
components: components:
securitySchemes: securitySchemes:
# Note: this is the same access_token definition used elsewhere in the client
# server API, however this expects an access token for an application service.
$ref: definitions/security.yaml $ref: definitions/security.yaml

6
data/api/client-server/banning.yaml
View file

@ -27,7 +27,8 @@ paths:
The caller must have the required power level in order to perform this operation. The caller must have the required power level in order to perform this operation.
operationId: ban operationId: ban
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId
@ -96,7 +97,8 @@ paths:
The caller must have the required power level in order to perform this operation. The caller must have the required power level in order to perform this operation.
operationId: unban operationId: unban
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/capabilities.yaml
View file

@ -24,7 +24,8 @@ paths:
and other relevant capabilities. and other relevant capabilities.
operationId: getCapabilities operationId: getCapabilities
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The capabilities of the server. description: The capabilities of the server.

12
data/api/client-server/content-repo.yaml
View file

@ -22,7 +22,8 @@ paths:
summary: Upload some content to the content repository. summary: Upload some content to the content repository.
operationId: uploadContent operationId: uploadContent
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: header - in: header
name: Content-Type name: Content-Type
@ -234,7 +235,8 @@ paths:
operationId: createContent operationId: createContent
x-addedInMatrixVersion: "1.7" x-addedInMatrixVersion: "1.7"
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
# empty json object # empty json object
responses: responses:
"200": "200":
@ -741,7 +743,8 @@ paths:
being shared should also not be shared with the homeserver. being shared should also not be shared with the homeserver.
operationId: getUrlPreview operationId: getUrlPreview
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: url name: url
@ -816,7 +819,8 @@ paths:
than is advertised by the server on this endpoint. than is advertised by the server on this endpoint.
operationId: getConfig operationId: getConfig
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The public content repository configuration for the matrix server. description: The public content repository configuration for the matrix server.

3
data/api/client-server/create_room.yaml
View file

@ -64,7 +64,8 @@ paths:
`creation_content`. `creation_content`.
operationId: createRoom operationId: createRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:

6
data/api/client-server/cross_signing.yaml
View file

@ -26,7 +26,8 @@ paths:
This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api). This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
operationId: uploadCrossSigningKeys operationId: uploadCrossSigningKeys
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -155,7 +156,8 @@ paths:
property, which contains the new signature(s) to add. property, which contains the new signature(s) to add.
operationId: uploadCrossSigningSignatures operationId: uploadCrossSigningSignatures
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:

32
data/api/client-server/definitions/security.yaml
View file

@ -11,8 +11,36 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
accessToken: accessTokenQuery:
type: apiKey type: apiKey
description: The access_token returned by a call to `/login` or `/register` description: |-
The `access_token` returned by a call to `/login` or `/register`, as a query
parameter.
It can also be the `as_token` of an application service.
name: access_token name: access_token
in: query in: query
accessTokenBearer:
type: http
description: |-
The `access_token` returned by a call to `/login` or `/register`, using the
`Authorization: Bearer` header.
It can also be the `as_token` of an application service.
This is the preferred method.
scheme: bearer
appserviceAccessTokenQuery:
type: apiKey
description: |-
The `as_token` of an application service, as a query parameter.
name: access_token
in: query
appserviceAccessTokenBearer:
type: http
description: |-
The `as_token` of an application service, using the `Authorization: Bearer`
header.
This is the preferred method.
scheme: bearer

15
data/api/client-server/device_management.yaml
View file

@ -22,7 +22,8 @@ paths:
description: Gets information about all devices for the current user. description: Gets information about all devices for the current user.
operationId: getDevices operationId: getDevices
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: Device information description: Device information
@ -58,7 +59,8 @@ paths:
description: Gets information on a single device, by device id. description: Gets information on a single device, by device id.
operationId: getDevice operationId: getDevice
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: deviceId name: deviceId
@ -93,7 +95,8 @@ paths:
description: Updates the metadata on the given device. description: Updates the metadata on the given device.
operationId: updateDevice operationId: updateDevice
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: deviceId name: deviceId
@ -140,7 +143,8 @@ paths:
Deletes the given device, and invalidates any access token associated with it. Deletes the given device, and invalidates any access token associated with it.
operationId: deleteDevice operationId: deleteDevice
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: deviceId name: deviceId
@ -191,7 +195,8 @@ paths:
Deletes the given devices, and invalidates any access token associated with them. Deletes the given devices, and invalidates any access token associated with them.
operationId: deleteDevices operationId: deleteDevices
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:

9
data/api/client-server/directory.yaml
View file

@ -21,7 +21,8 @@ paths:
summary: Create a new mapping from room alias to room ID. summary: Create a new mapping from room alias to room ID.
operationId: setRoomAlias operationId: setRoomAlias
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomAlias name: roomAlias
@ -172,7 +173,8 @@ paths:
have permission to update the `m.room.canonical_alias` event. have permission to update the `m.room.canonical_alias` event.
operationId: deleteRoomAlias operationId: deleteRoomAlias
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomAlias name: roomAlias
@ -229,7 +231,8 @@ paths:
state event. state event.
operationId: getLocalAliases operationId: getLocalAliases
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/event_context.yaml
View file

@ -28,7 +28,8 @@ paths:
[Lazy-loading room members](/client-server-api/#lazy-loading-room-members) for more information. [Lazy-loading room members](/client-server-api/#lazy-loading-room-members) for more information.
operationId: getEventContext operationId: getEventContext
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

6
data/api/client-server/filter.yaml
View file

@ -25,7 +25,8 @@ paths:
restrict which events are returned to the client. restrict which events are returned to the client.
operationId: defineFilter operationId: defineFilter
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -119,7 +120,8 @@ paths:
summary: Download a filter summary: Download a filter
operationId: getFilter operationId: getFilter
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

3
data/api/client-server/inviting.yaml
View file

@ -38,7 +38,8 @@ paths:
`m.room.member` event to the room. `m.room.member` event to the room.
operationId: inviteUser operationId: inviteUser
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

6
data/api/client-server/joining.yaml
View file

@ -33,7 +33,8 @@ paths:
and [`/sync`](/client-server-api/#get_matrixclientv3sync) APIs. and [`/sync`](/client-server-api/#get_matrixclientv3sync) APIs.
operationId: joinRoomById operationId: joinRoomById
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId
@ -126,7 +127,8 @@ paths:
and [`/sync`](/client-server-api/#get_matrixclientv3sync) APIs. and [`/sync`](/client-server-api/#get_matrixclientv3sync) APIs.
operationId: joinRoom operationId: joinRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomIdOrAlias name: roomIdOrAlias

42
data/api/client-server/key_backup.yaml
View file

@ -23,7 +23,8 @@ paths:
description: Creates a new backup. description: Creates a new backup.
operationId: postRoomKeysVersion operationId: postRoomKeysVersion
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -80,7 +81,8 @@ paths:
description: Get information about the latest backup version. description: Get information about the latest backup version.
operationId: getRoomKeysVersionCurrent operationId: getRoomKeysVersionCurrent
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The information about the backup. description: The information about the backup.
@ -155,7 +157,8 @@ paths:
description: Get information about an existing backup. description: Get information about an existing backup.
operationId: getRoomKeysVersion operationId: getRoomKeysVersion
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: version name: version
@ -242,7 +245,8 @@ paths:
be modified. be modified.
operationId: putRoomKeysVersion operationId: putRoomKeysVersion
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: version name: version
@ -344,7 +348,8 @@ paths:
as well as all key data related to the backup will be deleted. as well as all key data related to the backup will be deleted.
operationId: deleteRoomKeysVersion operationId: deleteRoomKeysVersion
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: version name: version
@ -396,7 +401,8 @@ paths:
description: Store a key in the backup. description: Store a key in the backup.
operationId: putRoomKeyBySessionId operationId: putRoomKeyBySessionId
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -478,7 +484,8 @@ paths:
description: Retrieve a key from the backup. description: Retrieve a key from the backup.
operationId: getRoomKeyBySessionId operationId: getRoomKeyBySessionId
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -534,7 +541,8 @@ paths:
description: Delete a key from the backup. description: Delete a key from the backup.
operationId: deleteRoomKeyBySessionId operationId: deleteRoomKeyBySessionId
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -606,7 +614,8 @@ paths:
description: Store several keys in the backup for a given room. description: Store several keys in the backup for a given room.
operationId: putRoomKeysByRoomId operationId: putRoomKeysByRoomId
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -693,7 +702,8 @@ paths:
description: Retrieve the keys from the backup for a given room. description: Retrieve the keys from the backup for a given room.
operationId: getRoomKeysByRoomId operationId: getRoomKeysByRoomId
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -745,7 +755,8 @@ paths:
description: Delete the keys from the backup for a given room. description: Delete the keys from the backup for a given room.
operationId: deleteRoomKeysByRoomId operationId: deleteRoomKeysByRoomId
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -810,7 +821,8 @@ paths:
description: Store several keys in the backup. description: Store several keys in the backup.
operationId: putRoomKeys operationId: putRoomKeys
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -910,7 +922,8 @@ paths:
description: Retrieve the keys from the backup. description: Retrieve the keys from the backup.
operationId: getRoomKeys operationId: getRoomKeys
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version
@ -974,7 +987,8 @@ paths:
description: Delete the keys from the backup. description: Delete the keys from the backup.
operationId: deleteRoomKeys operationId: deleteRoomKeys
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: version name: version

12
data/api/client-server/keys.yaml
View file

@ -24,7 +24,8 @@ paths:
description: Publishes end-to-end encryption keys for the device. description: Publishes end-to-end encryption keys for the device.
operationId: uploadKeys operationId: uploadKeys
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -120,7 +121,8 @@ paths:
description: Returns the current devices and identity keys for the given users. description: Returns the current devices and identity keys for the given users.
operationId: queryKeys operationId: queryKeys
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -283,7 +285,8 @@ paths:
description: Claims one-time keys for use in pre-key messages. description: Claims one-time keys for use in pre-key messages.
operationId: claimKeys operationId: claimKeys
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:
@ -383,7 +386,8 @@ paths:
identity keys, between `from` and `to`. identity keys, between `from` and `to`.
operationId: getKeysChanges operationId: getKeysChanges
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: from name: from

3
data/api/client-server/kicking.yaml
View file

@ -29,7 +29,8 @@ paths:
the target member's state by making a request to `/rooms/<room id>/state/m.room.member/<user id>`. the target member's state by making a request to `/rooms/<room id>/state/m.room.member/<user id>`.
operationId: kick operationId: kick
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/knocking.yaml
View file

@ -38,7 +38,8 @@ paths:
[`/sync`](/client-server-api/#get_matrixclientv3sync) API. [`/sync`](/client-server-api/#get_matrixclientv3sync) API.
operationId: knockRoom operationId: knockRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomIdOrAlias name: roomIdOrAlias

6
data/api/client-server/leaving.yaml
View file

@ -33,7 +33,8 @@ paths:
they were previously allowed to see. they were previously allowed to see.
operationId: leaveRoom operationId: leaveRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId
@ -91,7 +92,8 @@ paths:
before calling this API. before calling this API.
operationId: forgetRoom operationId: forgetRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/list_joined_rooms.yaml
View file

@ -22,7 +22,8 @@ paths:
description: This API returns a list of the user's current rooms. description: This API returns a list of the user's current rooms.
operationId: getJoinedRooms operationId: getJoinedRooms
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: A list of the rooms the user is in. description: A list of the rooms the user is in.

6
data/api/client-server/list_public_rooms.yaml
View file

@ -74,7 +74,8 @@ paths:
the room creator or a server administrator. the room creator or a server administrator.
operationId: setRoomVisibilityOnDirectory operationId: setRoomVisibilityOnDirectory
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId
@ -175,7 +176,8 @@ paths:
of joined members, with the largest rooms first. of joined members, with the largest rooms first.
operationId: queryPublicRooms operationId: queryPublicRooms
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: server name: server

3
data/api/client-server/login_token.yaml
View file

@ -53,7 +53,8 @@ paths:
operationId: generateLoginToken operationId: generateLoginToken
x-addedInMatrixVersion: "1.7" x-addedInMatrixVersion: "1.7"
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:

6
data/api/client-server/logout.yaml
View file

@ -25,7 +25,8 @@ paths:
[Device keys](/client-server-api/#device-keys) for the device are deleted alongside the device. [Device keys](/client-server-api/#device-keys) for the device are deleted alongside the device.
operationId: logout operationId: logout
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The access token used in the request was successfully invalidated. description: The access token used in the request was successfully invalidated.
@ -53,7 +54,8 @@ paths:
this way. this way.
operationId: logout_all operationId: logout_all
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The user's access tokens were successfully invalidated. description: The user's access tokens were successfully invalidated.

3
data/api/client-server/message_pagination.yaml
View file

@ -27,7 +27,8 @@ paths:
[Lazy-loading room members](/client-server-api/#lazy-loading-room-members) for more information. [Lazy-loading room members](/client-server-api/#lazy-loading-room-members) for more information.
operationId: getRoomEvents operationId: getRoomEvents
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/notifications.yaml
View file

@ -24,7 +24,8 @@ paths:
user has been, or would have been notified about. user has been, or would have been notified about.
operationId: getNotifications operationId: getNotifications
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: from name: from

9
data/api/client-server/old_sync.yaml
View file

@ -29,7 +29,8 @@ paths:
the [migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints). the [migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints).
operationId: getEvents operationId: getEvents
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: from name: from
@ -99,7 +100,8 @@ paths:
the [migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints). the [migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints).
operationId: initialSync operationId: initialSync
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: limit name: limit
@ -325,7 +327,8 @@ paths:
or the [/rooms/{roomId}/context/{eventId](/client-server-api/#get_matrixclientv3roomsroomidcontexteventid) API. or the [/rooms/{roomId}/context/{eventId](/client-server-api/#get_matrixclientv3roomsroomidcontexteventid) API.
operationId: getOneEvent operationId: getOneEvent
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: eventId name: eventId

3
data/api/client-server/openid.yaml
View file

@ -30,7 +30,8 @@ paths:
example. example.
operationId: requestOpenIdToken operationId: requestOpenIdToken
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

3
data/api/client-server/peeking_events.yaml
View file

@ -34,7 +34,8 @@ paths:
yet known. yet known.
operationId: peekEvents operationId: peekEvents
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: from name: from

6
data/api/client-server/presence.yaml
View file

@ -26,7 +26,8 @@ paths:
presence state of another user. presence state of another user.
operationId: setPresence operationId: setPresence
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -82,7 +83,8 @@ paths:
description: Get the given user's presence state. description: Get the given user's presence state.
operationId: getPresence operationId: getPresence
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

6
data/api/client-server/profile.yaml
View file

@ -24,7 +24,8 @@ paths:
set this user's display name, e.g. you need to have their `access_token`. set this user's display name, e.g. you need to have their `access_token`.
operationId: setDisplayName operationId: setDisplayName
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -109,7 +110,8 @@ paths:
set this user's avatar URL, e.g. you need to have their `access_token`. set this user's avatar URL, e.g. you need to have their `access_token`.
operationId: setAvatarUrl operationId: setAvatarUrl
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

6
data/api/client-server/pusher.yaml
View file

@ -23,7 +23,8 @@ paths:
description: Gets all currently active pushers for the authenticated user. description: Gets all currently active pushers for the authenticated user.
operationId: getPushers operationId: getPushers
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The pushers for this user. description: The pushers for this user.
@ -136,7 +137,8 @@ paths:
user is deleted. user is deleted.
operationId: postPusher operationId: postPusher
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:

24
data/api/client-server/pushrules.yaml
View file

@ -26,7 +26,8 @@ paths:
specified key e.g. the `global` key. specified key e.g. the `global` key.
operationId: getPushRules operationId: getPushRules
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: All the push rulesets for this user. description: All the push rulesets for this user.
@ -242,7 +243,8 @@ paths:
description: Retrieve a single specified push rule. description: Retrieve a single specified push rule.
operationId: getPushRule operationId: getPushRule
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: scope name: scope
@ -313,7 +315,8 @@ paths:
description: This endpoint removes the push rule defined in the path. description: This endpoint removes the push rule defined in the path.
operationId: deletePushRule operationId: deletePushRule
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: scope name: scope
@ -389,7 +392,8 @@ paths:
When creating push rules, they MUST be enabled by default. When creating push rules, they MUST be enabled by default.
operationId: setPushRule operationId: setPushRule
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: scope name: scope
@ -527,7 +531,8 @@ paths:
description: This endpoint gets whether the specified push rule is enabled. description: This endpoint gets whether the specified push rule is enabled.
operationId: isPushRuleEnabled operationId: isPushRuleEnabled
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: scope name: scope
@ -598,7 +603,8 @@ paths:
push rule. push rule.
operationId: setPushRuleEnabled operationId: setPushRuleEnabled
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: scope name: scope
@ -676,7 +682,8 @@ paths:
description: This endpoint get the actions for the specified push rule. description: This endpoint get the actions for the specified push rule.
operationId: getPushRuleActions operationId: getPushRuleActions
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: scope name: scope
@ -756,7 +763,8 @@ paths:
This can be used to change the actions of builtin rules. This can be used to change the actions of builtin rules.
operationId: setPushRuleActions operationId: setPushRuleActions
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: scope name: scope

3
data/api/client-server/read_markers.yaml
View file

@ -25,7 +25,8 @@ paths:
the read receipt's location. the read receipt's location.
operationId: setReadMarker operationId: setReadMarker
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/receipts.yaml
View file

@ -25,7 +25,8 @@ paths:
specified. specified.
operationId: postReceipt operationId: postReceipt
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/redaction.yaml
View file

@ -33,7 +33,8 @@ paths:
Server administrators may redact events sent by users on their server. Server administrators may redact events sent by users on their server.
operationId: redactEvent operationId: redactEvent
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

6
data/api/client-server/registration.yaml
View file

@ -387,7 +387,8 @@ paths:
access token provided in the request. Whether other access tokens for access token provided in the request. Whether other access tokens for
the user are revoked depends on the request parameters. the user are revoked depends on the request parameters.
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
operationId: changePassword operationId: changePassword
requestBody: requestBody:
content: content:
@ -591,7 +592,8 @@ paths:
parameter because the homeserver is expected to sign the request to the parameter because the homeserver is expected to sign the request to the
identity server instead. identity server instead.
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
operationId: deactivateAccount operationId: deactivateAccount
requestBody: requestBody:
content: content:

9
data/api/client-server/relations.yaml
View file

@ -31,7 +31,8 @@ paths:
page 1 and a `to` token from page 2 to paginate over the same range, however. page 1 and a `to` token from page 2 to paginate over the same range, however.
operationId: getRelatingEvents operationId: getRelatingEvents
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- $ref: '#/components/parameters/roomId' - $ref: '#/components/parameters/roomId'
- $ref: '#/components/parameters/eventId' - $ref: '#/components/parameters/eventId'
@ -88,7 +89,8 @@ paths:
page 1 and a `to` token from page 2 to paginate over the same range, however. page 1 and a `to` token from page 2 to paginate over the same range, however.
operationId: getRelatingEventsWithRelType operationId: getRelatingEventsWithRelType
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- $ref: '#/components/parameters/roomId' - $ref: '#/components/parameters/roomId'
- $ref: '#/components/parameters/eventId' - $ref: '#/components/parameters/eventId'
@ -149,7 +151,8 @@ paths:
page 1 and a `to` token from page 2 to paginate over the same range, however. page 1 and a `to` token from page 2 to paginate over the same range, however.
operationId: getRelatingEventsWithRelTypeAndEventType operationId: getRelatingEventsWithRelTypeAndEventType
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- $ref: '#/components/parameters/roomId' - $ref: '#/components/parameters/roomId'
- $ref: '#/components/parameters/eventId' - $ref: '#/components/parameters/eventId'

3
data/api/client-server/report_content.yaml
View file

@ -65,7 +65,8 @@ paths:
description: The reason the content is being reported. May be blank. description: The reason the content is being reported. May be blank.
required: true required: true
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
x-changedInMatrixVersion: x-changedInMatrixVersion:
1.8: | 1.8: |
This endpoint now requires the user to be joined to the room. This endpoint now requires the user to be joined to the room.

3
data/api/client-server/room_event_by_timestamp.yaml
View file

@ -46,7 +46,8 @@ paths:
found in that direction is outside of the expected range. found in that direction is outside of the expected range.
operationId: getEventByTimestamp operationId: getEventByTimestamp
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/room_initial_sync.yaml
View file

@ -15,7 +15,8 @@ paths:
[migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints). [migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints).
operationId: roomInitialSync operationId: roomInitialSync
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/room_send.yaml
View file

@ -30,7 +30,8 @@ paths:
[Room Events](/client-server-api/#room-events) for the m. event specification. [Room Events](/client-server-api/#room-events) for the m. event specification.
operationId: sendMessage operationId: sendMessage
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/room_state.yaml
View file

@ -39,7 +39,8 @@ paths:
being removed or are already present in the state event. being removed or are already present in the state event.
operationId: setRoomStateWithKey operationId: setRoomStateWithKey
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/room_upgrades.yaml
View file

@ -22,7 +22,8 @@ paths:
description: Upgrades the given room to a particular room version. description: Upgrades the given room to a particular room version.
operationId: upgradeRoom operationId: upgradeRoom
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

15
data/api/client-server/rooms.yaml
View file

@ -24,7 +24,8 @@ paths:
retrieve this event e.g. by being a member in the room for this event. retrieve this event e.g. by being a member in the room for this event.
operationId: getOneRoomEvent operationId: getOneRoomEvent
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId
@ -78,7 +79,8 @@ paths:
taken from the state of the room when they left. taken from the state of the room when they left.
operationId: getRoomStateWithKey operationId: getRoomStateWithKey
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId
@ -128,7 +130,8 @@ paths:
description: Get the state events for the current state of a room. description: Get the state events for the current state of a room.
operationId: getRoomState operationId: getRoomState
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId
@ -234,7 +237,8 @@ paths:
- leave - leave
- ban - ban
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: |- description: |-
@ -284,7 +288,8 @@ paths:
schema: schema:
type: string type: string
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: A map of MXID to room member objects. description: A map of MXID to room member objects.

3
data/api/client-server/search.yaml
View file

@ -22,7 +22,8 @@ paths:
description: Performs a full text search across different categories. description: Performs a full text search across different categories.
operationId: search operationId: search
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: next_batch name: next_batch

3
data/api/client-server/space_hierarchy.yaml
View file

@ -30,7 +30,8 @@ paths:
rooms and parent events are not covered by this endpoint. rooms and parent events are not covered by this endpoint.
operationId: getSpaceHierarchy operationId: getSpaceHierarchy
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/sync.yaml
View file

@ -43,7 +43,8 @@ paths:
events, alongside other state, when lazy-loading is not enabled. events, alongside other state, when lazy-loading is not enabled.
operationId: sync operationId: sync
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: filter name: filter

9
data/api/client-server/tags.yaml
View file

@ -23,7 +23,8 @@ paths:
description: List the tags set by a user on a room. description: List the tags set by a user on a room.
operationId: getRoomTags operationId: getRoomTags
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -83,7 +84,8 @@ paths:
description: Add a tag to the room. description: Add a tag to the room.
operationId: setRoomTag operationId: setRoomTag
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId
@ -143,7 +145,8 @@ paths:
description: Remove a tag from the room. description: Remove a tag from the room.
operationId: deleteRoomTag operationId: deleteRoomTag
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

18
data/api/client-server/third_party_lookup.yaml
View file

@ -25,7 +25,8 @@ paths:
required for queries against each protocol. required for queries against each protocol.
operationId: getProtocols operationId: getProtocols
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The protocols supported by the homeserver. description: The protocols supported by the homeserver.
@ -42,7 +43,8 @@ paths:
third-party protocol. third-party protocol.
operationId: getProtocolMetadata operationId: getProtocolMetadata
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: protocol name: protocol
@ -85,7 +87,8 @@ paths:
as reasonably possible given the network type. as reasonably possible given the network type.
operationId: queryLocationByProtocol operationId: queryLocationByProtocol
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: protocol name: protocol
@ -129,7 +132,8 @@ paths:
a set of user parameters. a set of user parameters.
operationId: queryUserByProtocol operationId: queryUserByProtocol
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: protocol name: protocol
@ -174,7 +178,8 @@ paths:
alias. alias.
operationId: queryLocationByAlias operationId: queryLocationByAlias
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: alias name: alias
@ -209,7 +214,8 @@ paths:
description: Retrieve an array of third-party users from a Matrix User ID. description: Retrieve an array of third-party users from a Matrix User ID.
operationId: queryUserByID operationId: queryUserByID
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: query - in: query
name: userid name: userid

3
data/api/client-server/third_party_membership.yaml
View file

@ -62,7 +62,8 @@ paths:
append a `m.room.third_party_invite` event to the room. append a `m.room.third_party_invite` event to the room.
operationId: inviteBy3PID operationId: inviteBy3PID
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/threads_list.yaml
View file

@ -27,7 +27,8 @@ paths:
user has participated in the thread. user has participated in the thread.
operationId: getThreadRoots operationId: getThreadRoots
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: roomId name: roomId

3
data/api/client-server/to_device.yaml
View file

@ -24,7 +24,8 @@ paths:
client devices. client devices.
operationId: sendToDevice operationId: sendToDevice
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: eventType name: eventType

3
data/api/client-server/typing.yaml
View file

@ -26,7 +26,8 @@ paths:
user has stopped typing. user has stopped typing.
operationId: setTyping operationId: setTyping
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
parameters: parameters:
- in: path - in: path
name: userId name: userId

3
data/api/client-server/users.yaml
View file

@ -32,7 +32,8 @@ paths:
`Accept-Language` header provided in the request, if present. `Accept-Language` header provided in the request, if present.
operationId: searchUserDirectory operationId: searchUserDirectory
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
requestBody: requestBody:
content: content:
application/json: application/json:

3
data/api/client-server/versions.yaml
View file

@ -45,7 +45,8 @@ paths:
operationId: getVersions operationId: getVersions
security: security:
- {} - {}
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
x-changedInMatrixVersion: x-changedInMatrixVersion:
"1.10": | "1.10": |
This endpoint can behave differently when authentication is provided. This endpoint can behave differently when authentication is provided.

3
data/api/client-server/voip.yaml
View file

@ -24,7 +24,8 @@ paths:
calls. calls.
operationId: getTurnServer operationId: getTurnServer
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The TURN server credentials. description: The TURN server credentials.

3
data/api/client-server/whoami.yaml
View file

@ -30,7 +30,8 @@ paths:
body. body.
operationId: getTokenOwner operationId: getTokenOwner
security: security:
- accessToken: [] - accessTokenQuery: []
- accessTokenBearer: []
responses: responses:
"200": "200":
description: The token belongs to a known user. description: The token belongs to a known user.