mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-10 21:44:11 +01:00
41 lines
1.2 KiB
YAML
41 lines
1.2 KiB
YAML
|
---
|
||
|
|
allOf:
|
||
|
|
- $ref: core-event-schema/event.yaml
|
||
|
|
description: |-
|
||
|
|
Sent by a client to request a secret from another device or to cancel a
|
||
|
|
previous request. It is sent as an unencrypted to-device event.
|
||
|
|
properties:
|
||
|
|
content:
|
||
|
|
properties:
|
||
|
|
name:
|
||
|
|
type: string
|
||
|
|
description: |-
|
||
|
|
Required if `action` is `request`. The name of the secret that is
|
||
|
|
being requested.
|
||
|
|
action:
|
||
|
|
type: string
|
||
|
|
enum:
|
||
|
|
- request
|
||
|
|
- request_cancellation
|
||
|
|
requesting_device_id:
|
||
|
|
type: string
|
||
|
|
description: |-
|
||
|
|
The ID of the device requesting the secret.
|
||
|
|
request_id:
|
||
|
|
type: string
|
||
|
|
description: |-
|
||
|
|
A random string uniquely identifying (with respect to the requester
|
||
|
|
and the target) the target for a secret. If the secret is requested
|
||
|
|
from multiple devices at the same time, the same ID may be used for
|
||
|
|
every target. The same ID is also used in order to cancel a previous
|
||
|
|
request.
|
||
|
|
required:
|
||
|
|
- action
|
||
|
|
- requesting_device_id
|
||
|
|
- request_id
|
||
|
|
type:
|
||
|
|
enum:
|
||
|
|
- m.secret.request
|
||
|
|
type: string
|
||
|
|
type: object
|