You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
1.5 KiB
YAML
45 lines
1.5 KiB
YAML
# Copyright 2025 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: Invite3pid
|
|
properties:
|
|
id_server:
|
|
type: string
|
|
description: The hostname+port of the identity server which should be used for
|
|
third-party identifier lookups.
|
|
id_access_token:
|
|
type: string
|
|
description: |-
|
|
An access token previously registered with the identity server. Servers
|
|
can treat this as optional to distinguish between r0.5-compatible clients
|
|
and this specification version.
|
|
medium:
|
|
type: string
|
|
description: |-
|
|
The kind of address being passed in the address field, for example `email`
|
|
(see [the list of recognised values](/appendices/#3pid-types)).
|
|
address:
|
|
type: string
|
|
description: The invitee's third-party identifier.
|
|
required:
|
|
- id_server
|
|
- id_access_token
|
|
- medium
|
|
- address
|
|
example: {
|
|
"id_server": "matrix.org",
|
|
"id_access_token": "abc123_OpaqueString",
|
|
"medium": "email",
|
|
"address": "cheeky@monkey.com"
|
|
} |