mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
6e16a19ac9
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
47 lines
1.6 KiB
YAML
47 lines
1.6 KiB
YAML
---
|
|
$schema: https://json-schema.org/draft/2020-12/schema
|
|
|
|
allOf:
|
|
- $ref: core-event-schema/event.yaml
|
|
|
|
description: |-
|
|
Begins a key verification process. Typically sent as a [to-device](/client-server-api/#send-to-device-messaging) event. The `method`
|
|
field determines the type of verification. The fields in the event will differ depending
|
|
on the `method`. This definition includes fields that are in common among all variants.
|
|
properties:
|
|
content:
|
|
properties:
|
|
from_device:
|
|
type: string
|
|
description: |-
|
|
The device ID which is initiating the process.
|
|
transaction_id:
|
|
type: string
|
|
description: |-
|
|
Required when sent as a to-device message. An opaque identifier for
|
|
the verification process. Must be unique with respect to the devices
|
|
involved. Must be the same as the `transaction_id` given in the
|
|
`m.key.verification.request` if this process is originating from a
|
|
request.
|
|
method:
|
|
type: string
|
|
description: |-
|
|
The verification method to use.
|
|
next_method:
|
|
type: string
|
|
description: |-
|
|
Optional method to use to verify the other user's key with. Applicable
|
|
when the `method` chosen only verifies one user's key. This field will
|
|
never be present if the `method` verifies keys both ways.
|
|
m.relates_to:
|
|
$ref: m.key.verification.m.relates_to.yaml
|
|
required:
|
|
- from_device
|
|
- method
|
|
type: object
|
|
type:
|
|
enum:
|
|
- m.key.verification.start
|
|
type: string
|
|
type: object
|