matrix-spec/data/event-schemas/schema/m.room_key_bundle.yaml
Richard van der Hoff 68ffc62de3
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
Spec / Create release (push) Has been cancelled
Specify history sharing (#2399)
Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com>
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
2026-06-24 12:00:12 +01:00

43 lines
1.2 KiB
YAML

---
$schema: https://json-schema.org/draft/2020-12/schema
allOf:
- $ref: core-event-schema/event.yaml
description: |-
This event type is used to share a bundle of room keys when inviting a new user to the room.
It is encrypted as an
[`m.room.encrypted`](/client-server-api/#mroomencrypted) [to-device
event](/client-server-api/#send-to-device-messaging) using
[Olm](/client-server-api/#molmv1curve25519-aes-sha2).
The `sender_device_keys` property in the [Olm
plaintext](/client-server-api/#definition-olmpayload) MUST be
populated. Recipients SHOULD ignore `m.room_key_bundle` messages which omit
them.
properties:
content:
properties:
room_id:
type: string
format: mx-room-id
pattern: "^!"
description: The room to which the keys in the key bundle relate.
file:
description: |-
An [EncryptedFile](/client-server-api/#definition-encryptedfile)
structure. The location and decryption keys for the encrypted
[`RoomKeyBundle`](/client-server-api/#definition-roomkeybundle).
title: EncryptedFile
type: object
required:
- room_id
- file
type: object
type:
enum:
- m.room_key_bundle
type: string
type: object