matrix-spec/data/api/client-server/definitions/third_party_signed.yaml

# Copyright 2019 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
type: object
title: Third Party Signed
description: |-
  A signature of an `m.third_party_invite` token to prove that this user
  owns a third party identity which has been invited to the room.
properties:
  sender:
    type: string
    description: The Matrix ID of the user who issued the invite.
    example: "@alice:example.org"
  mxid:
    type: string
    description: The Matrix ID of the invitee.
    example: "@bob:example.org"
  token:
    type: string
    description: The state key of the m.third_party_invite event.
    example: "random8nonce"
  signatures:
    type: object
    description: A signatures object containing a signature of the entire signed object.
    title: Signatures
    additionalProperties:
      type: object
      additionalProperties:
        type: string
    example: {
      "example.org": {
        "ed25519:0": "some9signature"
      }
    }
required: ["sender", "mxid", "token", "signatures"]