Merge branch 'master' into babolivier/standardised-federation-response-format
Brendan Abolivier
5 years ago
commit
48e8c55138
@ -0,0 +1,26 @@
|
|||||||
|
# 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
|
||||||
|
allOf:
|
||||||
|
- $ref: "../../identity/definitions/request_email_validation.yaml"
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
id_server:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The hostname of the identity server to communicate with. May optionally
|
||||||
|
include a port. This parameter is ignored when the homeserver handles
|
||||||
|
3PID verification.
|
||||||
|
example: "id.example.com"
|
||||||
|
required: ["id_server"]
|
||||||
@ -0,0 +1,26 @@
|
|||||||
|
# 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
|
||||||
|
allOf:
|
||||||
|
- $ref: "../../identity/definitions/request_msisdn_validation.yaml"
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
id_server:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The hostname of the identity server to communicate with. May optionally
|
||||||
|
include a port. This parameter is ignored when the homeserver handles
|
||||||
|
3PID verification.
|
||||||
|
example: "id.example.com"
|
||||||
|
required: ["id_server"]
|
||||||
@ -0,0 +1,37 @@
|
|||||||
|
# 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
|
||||||
|
properties:
|
||||||
|
sid:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The session ID. Session IDs are opaque strings that must consist entirely
|
||||||
|
of the characters ``[0-9a-zA-Z.=_-]``. Their length must not exceed 255
|
||||||
|
characters and they must not be empty.
|
||||||
|
example: "123abc"
|
||||||
|
submit_url:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
An optional field containing a URL where the client must submit the
|
||||||
|
validation token to, with identical parameters to the Identity Service
|
||||||
|
API's ``POST /validate/email/submitToken`` endpoint. The homeserver must
|
||||||
|
send this token to the user (if applicable), who should then be
|
||||||
|
prompted to provide it to the client.
|
||||||
|
|
||||||
|
If this field is not present, the client can assume that verification
|
||||||
|
will happen without the client's involvement provided the homeserver
|
||||||
|
advertises this specification version in the ``/versions`` response
|
||||||
|
(ie: r0.5.0).
|
||||||
|
example: "https://example.org/path/to/submitToken"
|
||||||
|
required: ['sid']
|
||||||
@ -0,0 +1,41 @@
|
|||||||
|
# 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
|
||||||
|
example: {
|
||||||
|
"example.org": {
|
||||||
|
"ed25519:0": "some9signature"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
required: ["sender", "mxid", "token", "signatures"]
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
# 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.
|
||||||
|
accessToken:
|
||||||
|
type: apiKey
|
||||||
|
description: The access_token returned by a call to ``/register``.
|
||||||
|
name: access_token
|
||||||
|
in: query
|
||||||
@ -0,0 +1,308 @@
|
|||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
|
# 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.
|
||||||
|
swagger: '2.0'
|
||||||
|
info:
|
||||||
|
title: "Matrix Identity Service Establishing Associations API"
|
||||||
|
version: "2.0.0"
|
||||||
|
host: localhost:8090
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/identity/v2
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
securityDefinitions:
|
||||||
|
$ref: definitions/security.yaml
|
||||||
|
paths:
|
||||||
|
"/3pid/getValidated3pid":
|
||||||
|
get:
|
||||||
|
summary: Check whether ownership of a 3pid was validated.
|
||||||
|
description: |-
|
||||||
|
Determines if a given 3pid has been validated by a user.
|
||||||
|
operationId: getValidated3pidV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: sid
|
||||||
|
description: The Session ID generated by the ``requestToken`` call.
|
||||||
|
required: true
|
||||||
|
x-example: 1234
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: client_secret
|
||||||
|
description: The client secret passed to the ``requestToken`` call.
|
||||||
|
required: true
|
||||||
|
x-example: monkeys_are_GREAT
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: Validation information for the session.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"medium": "email",
|
||||||
|
"validated_at": 1457622739026,
|
||||||
|
"address": "louise@bobs.burgers"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
medium:
|
||||||
|
type: string
|
||||||
|
description: The medium type of the 3pid.
|
||||||
|
address:
|
||||||
|
type: string
|
||||||
|
description: The address of the 3pid being looked up.
|
||||||
|
validated_at:
|
||||||
|
type: integer
|
||||||
|
description: |-
|
||||||
|
Timestamp, in milliseconds, indicating the time that the 3pid
|
||||||
|
was validated.
|
||||||
|
required: ['medium', 'address', 'validated_at']
|
||||||
|
400:
|
||||||
|
description: |-
|
||||||
|
The session has not been validated.
|
||||||
|
|
||||||
|
If the session has not been validated, then ``errcode`` will be
|
||||||
|
``M_SESSION_NOT_VALIDATED``. If the session has timed out, then
|
||||||
|
``errcode`` will be ``M_SESSION_EXPIRED``.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_SESSION_NOT_VALIDATED",
|
||||||
|
"error": "This validation session has not yet been completed"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
404:
|
||||||
|
description: The Session ID or client secret were not found.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_NO_VALID_SESSION",
|
||||||
|
"error": "No valid session was found matching that sid and client secret"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
"/3pid/bind":
|
||||||
|
post:
|
||||||
|
summary: Publish an association between a session and a Matrix user ID.
|
||||||
|
description: |-
|
||||||
|
Publish an association between a session and a Matrix user ID.
|
||||||
|
|
||||||
|
Future calls to ``/lookup`` for any of the session\'s 3pids will return
|
||||||
|
this association.
|
||||||
|
|
||||||
|
Note: for backwards compatibility with previous drafts of this
|
||||||
|
specification, the parameters may also be specified as
|
||||||
|
``application/x-form-www-urlencoded`` data. However, this usage is
|
||||||
|
deprecated.
|
||||||
|
operationId: bindV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
example: {
|
||||||
|
"sid": "1234",
|
||||||
|
"client_secret": "monkeys_are_GREAT",
|
||||||
|
"mxid": "@ears:matrix.org"
|
||||||
|
}
|
||||||
|
properties:
|
||||||
|
sid:
|
||||||
|
type: string
|
||||||
|
description: The Session ID generated by the ``requestToken`` call.
|
||||||
|
client_secret:
|
||||||
|
type: string
|
||||||
|
description: The client secret passed to the ``requestToken`` call.
|
||||||
|
mxid:
|
||||||
|
type: string
|
||||||
|
description: The Matrix user ID to associate with the 3pids.
|
||||||
|
required: ["sid", "client_secret", "mxid"]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The association was published.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"address": "louise@bobs.burgers",
|
||||||
|
"medium": "email",
|
||||||
|
"mxid": "@ears:matrix.org",
|
||||||
|
"not_before": 1428825849161,
|
||||||
|
"not_after": 4582425849161,
|
||||||
|
"ts": 1428825849161,
|
||||||
|
"signatures": {
|
||||||
|
"matrix.org": {
|
||||||
|
"ed25519:0": "ENiU2YORYUJgE6WBMitU0mppbQjidDLanAusj8XS2nVRHPu+0t42OKA/r6zV6i2MzUbNQ3c3MiLScJuSsOiVDQ"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
address:
|
||||||
|
type: string
|
||||||
|
description: The 3pid address of the user being looked up.
|
||||||
|
medium:
|
||||||
|
type: string
|
||||||
|
description: The medium type of the 3pid.
|
||||||
|
mxid:
|
||||||
|
type: string
|
||||||
|
description: The Matrix user ID associated with the 3pid.
|
||||||
|
not_before:
|
||||||
|
type: integer
|
||||||
|
description: A unix timestamp before which the association is not known to be valid.
|
||||||
|
not_after:
|
||||||
|
type: integer
|
||||||
|
description: A unix timestamp after which the association is not known to be valid.
|
||||||
|
ts:
|
||||||
|
type: integer
|
||||||
|
description: The unix timestamp at which the association was verified.
|
||||||
|
signatures:
|
||||||
|
type: object
|
||||||
|
description: |-
|
||||||
|
The signatures of the verifying identity servers which show that the
|
||||||
|
association should be trusted, if you trust the verifying identity
|
||||||
|
services.
|
||||||
|
$ref: "../../schemas/server-signatures.yaml"
|
||||||
|
required:
|
||||||
|
- address
|
||||||
|
- medium
|
||||||
|
- mxid
|
||||||
|
- not_before
|
||||||
|
- not_after
|
||||||
|
- ts
|
||||||
|
- signatures
|
||||||
|
400:
|
||||||
|
description: |-
|
||||||
|
The association was not published.
|
||||||
|
|
||||||
|
If the session has not been validated, then ``errcode`` will be
|
||||||
|
``M_SESSION_NOT_VALIDATED``. If the session has timed out, then
|
||||||
|
``errcode`` will be ``M_SESSION_EXPIRED``.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_SESSION_NOT_VALIDATED",
|
||||||
|
"error": "This validation session has not yet been completed"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
404:
|
||||||
|
description: The Session ID or client secret were not found
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_NO_VALID_SESSION",
|
||||||
|
"error": "No valid session was found matching that sid and client secret"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
"/3pid/unbind":
|
||||||
|
post:
|
||||||
|
summary: Remove an association between a session and a Matrix user ID.
|
||||||
|
description: |-
|
||||||
|
Remove an association between a session and a Matrix user ID.
|
||||||
|
|
||||||
|
Future calls to ``/lookup`` for any of the session's 3pids will not
|
||||||
|
return the removed association.
|
||||||
|
|
||||||
|
The identity server should authenticate the request in one of two
|
||||||
|
ways:
|
||||||
|
|
||||||
|
1. The request is signed by the homeserver which controls the ``user_id``.
|
||||||
|
2. The request includes the ``sid`` and ``client_secret`` parameters,
|
||||||
|
as per ``/3pid/bind``, which proves ownership of the 3PID.
|
||||||
|
|
||||||
|
If this endpoint returns a JSON Matrix error, that error should be passed
|
||||||
|
through to the client requesting an unbind through a homeserver, if the
|
||||||
|
homeserver is acting on behalf of a client.
|
||||||
|
operationId: unbindV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
example: {
|
||||||
|
"sid": "1234",
|
||||||
|
"client_secret": "monkeys_are_GREAT",
|
||||||
|
"mxid": "@ears:example.org",
|
||||||
|
"threepid": {
|
||||||
|
"medium": "email",
|
||||||
|
"address": "monkeys_have_ears@example.org"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
properties:
|
||||||
|
sid:
|
||||||
|
type: string
|
||||||
|
description: The Session ID generated by the ``requestToken`` call.
|
||||||
|
client_secret:
|
||||||
|
type: string
|
||||||
|
description: The client secret passed to the ``requestToken`` call.
|
||||||
|
mxid:
|
||||||
|
type: string
|
||||||
|
description: The Matrix user ID to remove from the 3pids.
|
||||||
|
threepid:
|
||||||
|
type: object
|
||||||
|
title: 3PID
|
||||||
|
description: |-
|
||||||
|
The 3PID to remove. Must match the 3PID used to generate the session
|
||||||
|
if using ``sid`` and ``client_secret`` to authenticate this request.
|
||||||
|
properties:
|
||||||
|
medium:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
A medium from the `3PID Types`_ Appendix, matching the medium
|
||||||
|
of the identifier to unbind.
|
||||||
|
address:
|
||||||
|
type: string
|
||||||
|
description: The 3PID address to remove.
|
||||||
|
required: ['medium', 'address']
|
||||||
|
required: ["threepid", "mxid"]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The association was successfully removed.
|
||||||
|
examples:
|
||||||
|
application/json: {}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
400:
|
||||||
|
description: |-
|
||||||
|
If the response body is not a JSON Matrix error, the identity server
|
||||||
|
does not support unbinds. If a JSON Matrix error is in the response
|
||||||
|
body, the requesting party should respect the error.
|
||||||
|
404:
|
||||||
|
description: |-
|
||||||
|
If the response body is not a JSON Matrix error, the identity server
|
||||||
|
does not support unbinds. If a JSON Matrix error is in the response
|
||||||
|
body, the requesting party should respect the error.
|
||||||
|
403:
|
||||||
|
description: |-
|
||||||
|
The credentials supplied to authenticate the request were invalid.
|
||||||
|
This may also be returned if the identity server does not support
|
||||||
|
the chosen authentication method (such as blocking homeservers from
|
||||||
|
unbinding identifiers).
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_FORBIDDEN",
|
||||||
|
"error": "Invalid homeserver signature"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
501:
|
||||||
|
description: |-
|
||||||
|
If the response body is not a JSON Matrix error, the identity server
|
||||||
|
does not support unbinds. If a JSON Matrix error is in the response
|
||||||
|
body, the requesting party should respect the error.
|
||||||
@ -0,0 +1,183 @@
|
|||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
|
# 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.
|
||||||
|
swagger: '2.0'
|
||||||
|
info:
|
||||||
|
title: "Matrix Identity Service Email Associations API"
|
||||||
|
version: "2.0.0"
|
||||||
|
host: localhost:8090
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/identity/v2
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
securityDefinitions:
|
||||||
|
$ref: definitions/security.yaml
|
||||||
|
paths:
|
||||||
|
"/validate/email/requestToken":
|
||||||
|
post:
|
||||||
|
summary: Request a token for validating an email address.
|
||||||
|
description: |-
|
||||||
|
Create a session for validating an email address.
|
||||||
|
|
||||||
|
The identity server will send an email containing a token. If that
|
||||||
|
token is presented to the identity server in the future, it indicates
|
||||||
|
that that user was able to read the email for that email address, and
|
||||||
|
so we validate ownership of the email address.
|
||||||
|
|
||||||
|
Note that homeservers offer APIs that proxy this API, adding
|
||||||
|
additional behaviour on top, for example,
|
||||||
|
``/register/email/requestToken`` is designed specifically for use when
|
||||||
|
registering an account and therefore will inform the user if the email
|
||||||
|
address given is already registered on the server.
|
||||||
|
|
||||||
|
Note: for backwards compatibility with previous drafts of this
|
||||||
|
specification, the parameters may also be specified as
|
||||||
|
``application/x-form-www-urlencoded`` data. However, this usage is
|
||||||
|
deprecated.
|
||||||
|
operationId: emailRequestTokenV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
$ref: "definitions/request_email_validation.yaml"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: Session created.
|
||||||
|
schema:
|
||||||
|
$ref: "definitions/sid.yaml"
|
||||||
|
400:
|
||||||
|
description: |
|
||||||
|
An error ocurred. Some possible errors are:
|
||||||
|
|
||||||
|
- ``M_INVALID_EMAIL``: The email address provided was invalid.
|
||||||
|
- ``M_EMAIL_SEND_ERROR``: The validation email could not be sent.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_INVALID_EMAIL",
|
||||||
|
"error": "The email address is not valid"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
"/validate/email/submitToken":
|
||||||
|
post:
|
||||||
|
summary: Validate ownership of an email address.
|
||||||
|
description: |-
|
||||||
|
Validate ownership of an email address.
|
||||||
|
|
||||||
|
If the three parameters are consistent with a set generated by a
|
||||||
|
``requestToken`` call, ownership of the email address is considered to
|
||||||
|
have been validated. This does not publish any information publicly, or
|
||||||
|
associate the email address with any Matrix user ID. Specifically,
|
||||||
|
calls to ``/lookup`` will not show a binding.
|
||||||
|
|
||||||
|
The identity server is free to match the token case-insensitively, or
|
||||||
|
carry out other mapping operations such as unicode
|
||||||
|
normalisation. Whether to do so is an implementation detail for the
|
||||||
|
identity server. Clients must always pass on the token without
|
||||||
|
modification.
|
||||||
|
|
||||||
|
Note: for backwards compatibility with previous drafts of this
|
||||||
|
specification, the parameters may also be specified as
|
||||||
|
``application/x-form-www-urlencoded`` data. However, this usage is
|
||||||
|
deprecated.
|
||||||
|
operationId: emailSubmitTokenPostV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
example: {
|
||||||
|
"sid": "1234",
|
||||||
|
"client_secret": "monkeys_are_GREAT",
|
||||||
|
"token": "atoken"
|
||||||
|
}
|
||||||
|
properties:
|
||||||
|
sid:
|
||||||
|
type: string
|
||||||
|
description: The session ID, generated by the ``requestToken`` call.
|
||||||
|
client_secret:
|
||||||
|
type: string
|
||||||
|
description: The client secret that was supplied to the ``requestToken`` call.
|
||||||
|
token:
|
||||||
|
type: string
|
||||||
|
description: The token generated by the ``requestToken`` call and emailed to the user.
|
||||||
|
required: ["sid", "client_secret", "token"]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description:
|
||||||
|
The success of the validation.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"success": true
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the validation was successful or not.
|
||||||
|
required: ['success']
|
||||||
|
get:
|
||||||
|
summary: Validate ownership of an email address.
|
||||||
|
description: |-
|
||||||
|
Validate ownership of an email address.
|
||||||
|
|
||||||
|
If the three parameters are consistent with a set generated by a
|
||||||
|
``requestToken`` call, ownership of the email address is considered to
|
||||||
|
have been validated. This does not publish any information publicly, or
|
||||||
|
associate the email address with any Matrix user ID. Specifically,
|
||||||
|
calls to ``/lookup`` will not show a binding.
|
||||||
|
|
||||||
|
Note that, in contrast with the POST version, this endpoint will be
|
||||||
|
used by end-users, and so the response should be human-readable.
|
||||||
|
operationId: emailSubmitTokenGetV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: sid
|
||||||
|
required: true
|
||||||
|
description: The session ID, generated by the ``requestToken`` call.
|
||||||
|
x-example: 1234
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: client_secret
|
||||||
|
required: true
|
||||||
|
description: The client secret that was supplied to the ``requestToken`` call.
|
||||||
|
x-example: monkeys_are_GREAT
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: token
|
||||||
|
required: true
|
||||||
|
description: The token generated by the ``requestToken`` call and emailed to the user.
|
||||||
|
x-example: atoken
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Email address is validated.
|
||||||
|
"3xx":
|
||||||
|
description: |-
|
||||||
|
Email address is validated, and the ``next_link`` parameter was
|
||||||
|
provided to the ``requestToken`` call. The user must be redirected
|
||||||
|
to the URL provided by the ``next_link`` parameter.
|
||||||
|
"4xx":
|
||||||
|
description:
|
||||||
|
Validation failed.
|
||||||
@ -0,0 +1,101 @@
|
|||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
|
# 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.
|
||||||
|
swagger: '2.0'
|
||||||
|
info:
|
||||||
|
title: "Matrix Identity Service Ephemeral Invitation Signing API"
|
||||||
|
version: "2.0.0"
|
||||||
|
host: localhost:8090
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/identity/v2
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
securityDefinitions:
|
||||||
|
$ref: definitions/security.yaml
|
||||||
|
paths:
|
||||||
|
"/sign-ed25519":
|
||||||
|
post:
|
||||||
|
summary: Sign invitation details
|
||||||
|
description: |-
|
||||||
|
Sign invitation details.
|
||||||
|
|
||||||
|
The identity server will look up ``token`` which was stored in a call
|
||||||
|
to ``store-invite``, and fetch the sender of the invite.
|
||||||
|
operationId: blindlySignStuffV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
example: {
|
||||||
|
"mxid": "@foo:bar.com",
|
||||||
|
"token": "sometoken",
|
||||||
|
"private_key": "base64encodedkey"
|
||||||
|
}
|
||||||
|
properties:
|
||||||
|
mxid:
|
||||||
|
type: string
|
||||||
|
description: The Matrix user ID of the user accepting the invitation.
|
||||||
|
token:
|
||||||
|
type: string
|
||||||
|
description: The token from the call to ``store-invite``.
|
||||||
|
private_key:
|
||||||
|
type: string
|
||||||
|
description: The private key, encoded as `Unpadded base64`_.
|
||||||
|
required: ["mxid", "token", "private_key"]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The signed JSON of the mxid, sender, and token.
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
mxid:
|
||||||
|
type: string
|
||||||
|
description: The Matrix user ID of the user accepting the invitation.
|
||||||
|
sender:
|
||||||
|
type: string
|
||||||
|
description: The Matrix user ID of the user who sent the invitation.
|
||||||
|
signatures:
|
||||||
|
type: object
|
||||||
|
description: The signature of the mxid, sender, and token.
|
||||||
|
$ref: "../../schemas/server-signatures.yaml"
|
||||||
|
token:
|
||||||
|
type: string
|
||||||
|
description: The token for the invitation.
|
||||||
|
required: ['mxid', 'sender', 'signatures', 'token']
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"mxid": "@foo:bar.com",
|
||||||
|
"sender": "@baz:bar.com",
|
||||||
|
"signatures": {
|
||||||
|
"my.id.server": {
|
||||||
|
"ed25519:0": "def987"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"token": "abc123"
|
||||||
|
}
|
||||||
|
404:
|
||||||
|
description: The token was not found.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_UNRECOGNIZED",
|
||||||
|
"error": "Didn't recognize token"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
@ -0,0 +1,185 @@
|
|||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
|
# 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.
|
||||||
|
swagger: '2.0'
|
||||||
|
info:
|
||||||
|
title: "Matrix Identity Service Phone Number Associations API"
|
||||||
|
version: "2.0.0"
|
||||||
|
host: localhost:8090
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/identity/v2
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
securityDefinitions:
|
||||||
|
$ref: definitions/security.yaml
|
||||||
|
paths:
|
||||||
|
"/validate/msisdn/requestToken":
|
||||||
|
post:
|
||||||
|
summary: Request a token for validating a phone number.
|
||||||
|
description: |-
|
||||||
|
Create a session for validating a phone number.
|
||||||
|
|
||||||
|
The identity server will send an SMS message containing a token. If
|
||||||
|
that token is presented to the identity server in the future, it
|
||||||
|
indicates that that user was able to read the SMS for that phone
|
||||||
|
number, and so we validate ownership of the phone number.
|
||||||
|
|
||||||
|
Note that homeservers offer APIs that proxy this API, adding
|
||||||
|
additional behaviour on top, for example,
|
||||||
|
``/register/msisdn/requestToken`` is designed specifically for use when
|
||||||
|
registering an account and therefore will inform the user if the phone
|
||||||
|
number given is already registered on the server.
|
||||||
|
|
||||||
|
Note: for backwards compatibility with previous drafts of this
|
||||||
|
specification, the parameters may also be specified as
|
||||||
|
``application/x-form-www-urlencoded`` data. However, this usage is
|
||||||
|
deprecated.
|
||||||
|
operationId: msisdnRequestTokenV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
$ref: "definitions/request_msisdn_validation.yaml"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: Session created.
|
||||||
|
schema:
|
||||||
|
$ref: "definitions/sid.yaml"
|
||||||
|
400:
|
||||||
|
description: |
|
||||||
|
An error ocurred. Some possible errors are:
|
||||||
|
|
||||||
|
- ``M_INVALID_ADDRESS``: The phone number provided was invalid.
|
||||||
|
- ``M_SEND_ERROR``: The validation SMS could not be sent.
|
||||||
|
- ``M_DESTINATION_REJECTED``: The identity server cannot deliver an
|
||||||
|
SMS to the provided country or region.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_INVALID_ADDRESS",
|
||||||
|
"error": "The phone number is not valid"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
"/validate/msisdn/submitToken":
|
||||||
|
post:
|
||||||
|
summary: Validate ownership of a phone number.
|
||||||
|
description: |-
|
||||||
|
Validate ownership of a phone number.
|
||||||
|
|
||||||
|
If the three parameters are consistent with a set generated by a
|
||||||
|
``requestToken`` call, ownership of the phone number is considered to
|
||||||
|
have been validated. This does not publish any information publicly, or
|
||||||
|
associate the phone number address with any Matrix user
|
||||||
|
ID. Specifically, calls to ``/lookup`` will not show a binding.
|
||||||
|
|
||||||
|
The identity server is free to match the token case-insensitively, or
|
||||||
|
carry out other mapping operations such as unicode
|
||||||
|
normalisation. Whether to do so is an implementation detail for the
|
||||||
|
identity server. Clients must always pass on the token without
|
||||||
|
modification.
|
||||||
|
|
||||||
|
Note: for backwards compatibility with previous drafts of this
|
||||||
|
specification, the parameters may also be specified as
|
||||||
|
``application/x-form-www-urlencoded`` data. However, this usage is
|
||||||
|
deprecated.
|
||||||
|
operationId: msisdnSubmitTokenPostV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
example: {
|
||||||
|
"sid": "1234",
|
||||||
|
"client_secret": "monkeys_are_GREAT",
|
||||||
|
"token": "atoken"
|
||||||
|
}
|
||||||
|
properties:
|
||||||
|
sid:
|
||||||
|
type: string
|
||||||
|
description: The session ID, generated by the ``requestToken`` call.
|
||||||
|
client_secret:
|
||||||
|
type: string
|
||||||
|
description: The client secret that was supplied to the ``requestToken`` call.
|
||||||
|
token:
|
||||||
|
type: string
|
||||||
|
description: The token generated by the ``requestToken`` call and sent to the user.
|
||||||
|
required: ["sid", "client_secret", "token"]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description:
|
||||||
|
The success of the validation.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"success": true
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the validation was successful or not.
|
||||||
|
required: ['success']
|
||||||
|
get:
|
||||||
|
summary: Validate ownership of a phone number.
|
||||||
|
description: |-
|
||||||
|
Validate ownership of a phone number.
|
||||||
|
|
||||||
|
If the three parameters are consistent with a set generated by a
|
||||||
|
``requestToken`` call, ownership of the phone number address is
|
||||||
|
considered to have been validated. This does not publish any
|
||||||
|
information publicly, or associate the phone number with any Matrix
|
||||||
|
user ID. Specifically, calls to ``/lookup`` will not show a binding.
|
||||||
|
|
||||||
|
Note that, in contrast with the POST version, this endpoint will be
|
||||||
|
used by end-users, and so the response should be human-readable.
|
||||||
|
operationId: msisdnSubmitTokenGetV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: sid
|
||||||
|
required: true
|
||||||
|
description: The session ID, generated by the ``requestToken`` call.
|
||||||
|
x-example: 1234
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: client_secret
|
||||||
|
required: true
|
||||||
|
description: The client secret that was supplied to the ``requestToken`` call.
|
||||||
|
x-example: monkeys_are_GREAT
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: token
|
||||||
|
required: true
|
||||||
|
description: The token generated by the ``requestToken`` call and sent to the user.
|
||||||
|
x-example: atoken
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Phone number is validated.
|
||||||
|
"3xx":
|
||||||
|
description: |-
|
||||||
|
Phone number address is validated, and the ``next_link`` parameter
|
||||||
|
was provided to the ``requestToken`` call. The user must be
|
||||||
|
redirected to the URL provided by the ``next_link`` parameter.
|
||||||
|
"4xx":
|
||||||
|
description:
|
||||||
|
Validation failed.
|
||||||
@ -0,0 +1,46 @@
|
|||||||
|
# Copyright 2018 Kamax Sàrl
|
||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
swagger: "2.0"
|
||||||
|
info:
|
||||||
|
title: "Matrix Identity Service Ping API"
|
||||||
|
version: "2.0.0"
|
||||||
|
host: localhost:8090
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/identity
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
paths:
|
||||||
|
"/v2":
|
||||||
|
get:
|
||||||
|
summary: Checks that an identity server is available at this API endpoint.
|
||||||
|
description: |-
|
||||||
|
Checks that an identity server is available at this API endpoint.
|
||||||
|
|
||||||
|
To discover that an identity server is available at a specific URL,
|
||||||
|
this endpoint can be queried and will return an empty object.
|
||||||
|
|
||||||
|
This is primarly used for auto-discovery and health check purposes
|
||||||
|
by entities acting as a client for the identity server.
|
||||||
|
operationId: pingV2
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: An identity server is ready to serve requests.
|
||||||
|
examples:
|
||||||
|
application/json: {}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
@ -0,0 +1,127 @@
|
|||||||
|
# Copyright 2016 OpenMarket Ltd
|
||||||
|
# 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.
|
||||||
|
swagger: '2.0'
|
||||||
|
info:
|
||||||
|
title: "Matrix Identity Service Public Key API"
|
||||||
|
version: "2.0.0"
|
||||||
|
host: localhost:8090
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/identity/v2
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
paths:
|
||||||
|
"/pubkey/{keyId}":
|
||||||
|
get:
|
||||||
|
summary: Get a public key.
|
||||||
|
description: |-
|
||||||
|
Get the public key for the passed key ID.
|
||||||
|
operationId: getPubKeyV2
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
type: string
|
||||||
|
name: keyId
|
||||||
|
required: true
|
||||||
|
description: |-
|
||||||
|
The ID of the key. This should take the form algorithm:identifier
|
||||||
|
where algorithm identifies the signing algorithm, and the identifier
|
||||||
|
is an opaque string.
|
||||||
|
x-example: "ed25519:0"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description:
|
||||||
|
The public key exists.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"public_key": "VXuGitF39UH5iRfvbIknlvlAVKgD1BsLDMvBf0pmp7c"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
public_key:
|
||||||
|
type: string
|
||||||
|
description: Unpadded Base64 encoded public key.
|
||||||
|
required: ['public_key']
|
||||||
|
404:
|
||||||
|
description:
|
||||||
|
The public key was not found.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_NOT_FOUND",
|
||||||
|
"error": "The public key was not found"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
|
"/pubkey/isvalid":
|
||||||
|
get:
|
||||||
|
summary: Check whether a long-term public key is valid.
|
||||||
|
description: |-
|
||||||
|
Check whether a long-term public key is valid. The response should always
|
||||||
|
be the same, provided the key exists.
|
||||||
|
operationId: isPubKeyValidV2
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: public_key
|
||||||
|
required: true
|
||||||
|
description: |-
|
||||||
|
The unpadded base64-encoded public key to check.
|
||||||
|
x-example: "VXuGitF39UH5iRfvbIknlvlAVKgD1BsLDMvBf0pmp7c"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description:
|
||||||
|
The validity of the public key.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"valid": true
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
valid:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the public key is recognised and is currently valid.
|
||||||
|
required: ['valid']
|
||||||
|
"/pubkey/ephemeral/isvalid":
|
||||||
|
get:
|
||||||
|
summary: Check whether a short-term public key is valid.
|
||||||
|
description: |-
|
||||||
|
Check whether a short-term public key is valid.
|
||||||
|
operationId: isEphemeralPubKeyValidV2
|
||||||
|
parameters:
|
||||||
|
- in: query
|
||||||
|
type: string
|
||||||
|
name: public_key
|
||||||
|
required: true
|
||||||
|
description: |-
|
||||||
|
The unpadded base64-encoded public key to check.
|
||||||
|
x-example: "VXuGitF39UH5iRfvbIknlvlAVKgD1BsLDMvBf0pmp7c"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description:
|
||||||
|
The validity of the public key.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"valid": true
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
valid:
|
||||||
|
type: boolean
|
||||||
|
description: Whether the public key is recognised and is currently valid.
|
||||||
|
required: ['valid']
|
||||||
@ -0,0 +1,165 @@
|
|||||||
|
# Copyright 2018 New Vector Ltd
|
||||||
|
# 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.
|
||||||
|
swagger: '2.0'
|
||||||
|
info:
|
||||||
|
title: "Matrix Identity Service Store Invitations API"
|
||||||
|
version: "2.0.0"
|
||||||
|
host: localhost:8090
|
||||||
|
schemes:
|
||||||
|
- https
|
||||||
|
basePath: /_matrix/identity/v2
|
||||||
|
consumes:
|
||||||
|
- application/json
|
||||||
|
produces:
|
||||||
|
- application/json
|
||||||
|
securityDefinitions:
|
||||||
|
$ref: definitions/security.yaml
|
||||||
|
paths:
|
||||||
|
"/store-invite":
|
||||||
|
post:
|
||||||
|
summary: Store pending invitations to a user's 3pid.
|
||||||
|
description: |-
|
||||||
|
Store pending invitations to a user's 3pid.
|
||||||
|
|
||||||
|
In addition to the request parameters specified below, an arbitrary
|
||||||
|
number of other parameters may also be specified. These may be used in
|
||||||
|
the invite message generation described below.
|
||||||
|
|
||||||
|
The service will generate a random token and an ephemeral key used for
|
||||||
|
accepting the invite.
|
||||||
|
|
||||||
|
The service also generates a ``display_name`` for the inviter, which is
|
||||||
|
a redacted version of ``address`` which does not leak the full contents
|
||||||
|
of the ``address``.
|
||||||
|
|
||||||
|
The service records persistently all of the above information.
|
||||||
|
|
||||||
|
It also generates an email containing all of this data, sent to the
|
||||||
|
``address`` parameter, notifying them of the invitation.
|
||||||
|
|
||||||
|
Also, the generated ephemeral public key will be listed as valid on
|
||||||
|
requests to ``/_matrix/identity/v2/pubkey/ephemeral/isvalid``.
|
||||||
|
|
||||||
|
Currently, invites may only be issued for 3pids of the ``email`` medium.
|
||||||
|
|
||||||
|
Optional fields in the request should be populated to the best of the
|
||||||
|
server's ability. Identity servers may use these variables when notifying
|
||||||
|
the ``address`` of the pending invite for display purposes.
|
||||||
|
operationId: storeInviteV2
|
||||||
|
security:
|
||||||
|
- accessToken: []
|
||||||
|
parameters:
|
||||||
|
- in: body
|
||||||
|
name: body
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
medium:
|
||||||
|
type: string
|
||||||
|
description: The literal string ``email``.
|
||||||
|
example: "email"
|
||||||
|
address:
|
||||||
|
type: string
|
||||||
|
description: The email address of the invited user.
|
||||||
|
example: "foo@example.com"
|
||||||
|
room_id:
|
||||||
|
type: string
|
||||||
|
description: The Matrix room ID to which the user is invited
|
||||||
|
example: "!something:example.org"
|
||||||
|
sender:
|
||||||
|
type: string
|
||||||
|
description: The Matrix user ID of the inviting user
|
||||||
|
example: "@bob:example.com"
|
||||||
|
room_alias:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The Matrix room alias for the room to which the user is
|
||||||
|
invited. This should be retrieved from the ``m.room.canonical_alias``
|
||||||
|
state event.
|
||||||
|
example: "#somewhere:exmaple.org"
|
||||||
|
room_avatar_url:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The Content URI for the room to which the user is invited. This should
|
||||||
|
be retrieved from the ``m.room.avatar`` state event.
|
||||||
|
example: "mxc://example.org/s0meM3dia"
|
||||||
|
room_join_rules:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The ``join_rule`` for the room to which the user is invited. This should
|
||||||
|
be retrieved from the ``m.room.join_rules`` state event.
|
||||||
|
example: "public"
|
||||||
|
room_name:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The name of the room to which the user is invited. This should be retrieved
|
||||||
|
from the ``m.room.name`` state event.
|
||||||
|
example: "Bob's Emporium of Messages"
|
||||||
|
sender_display_name:
|
||||||
|
type: string
|
||||||
|
description: The display name of the user ID initiating the invite.
|
||||||
|
example: "Bob Smith"
|
||||||
|
sender_avatar_url:
|
||||||
|
type: string
|
||||||
|
description: The Content URI for the avatar of the user ID initiating the invite.
|
||||||
|
example: "mxc://example.org/an0th3rM3dia"
|
||||||
|
required: ["medium", "address", "room_id", "sender"]
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The invitation was stored.
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
token:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
The generated token. Must be a string consisting of the
|
||||||
|
characters ``[0-9a-zA-Z.=_-]``. Its length must not exceed
|
||||||
|
255 characters and it must not be empty.
|
||||||
|
public_keys:
|
||||||
|
type: array
|
||||||
|
description: |
|
||||||
|
A list of [server's long-term public key, generated ephemeral
|
||||||
|
public key].
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
display_name:
|
||||||
|
type: string
|
||||||
|
description: The generated (redacted) display_name.
|
||||||
|
required: ['token', 'public_keys', 'display_name']
|
||||||
|
example:
|
||||||
|
application/json: {
|
||||||
|
"token": "sometoken",
|
||||||
|
"public_keys": [
|
||||||
|
"serverpublickey",
|
||||||
|
"ephemeralpublickey"
|
||||||
|
],
|
||||||
|
"display_name": "f...@b..."
|
||||||
|
}
|
||||||
|
400:
|
||||||
|
description: |
|
||||||
|
An error has occured.
|
||||||
|
|
||||||
|
If the 3pid is already bound to a Matrix user ID, the error code
|
||||||
|
will be ``M_THREEPID_IN_USE``. If the medium is unsupported, the
|
||||||
|
error code will be ``M_UNRECOGNIZED``.
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_THREEPID_IN_USE",
|
||||||
|
"error": "Binding already known",
|
||||||
|
"mxid": "@alice:example.com"
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
$ref: "../client-server/definitions/errors/error.yaml"
|
||||||
@ -0,0 +1,47 @@
|
|||||||
|
# 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: Persistent Data Unit
|
||||||
|
description: A persistent data unit (event) for room version 4 and beyond.
|
||||||
|
example:
|
||||||
|
$ref: "../examples/pdu_v4.json"
|
||||||
|
allOf:
|
||||||
|
- $ref: "pdu_v3.yaml"
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
redacts:
|
||||||
|
type: string
|
||||||
|
description: For redaction events, the ID of the event being redacted.
|
||||||
|
example: "$def_456-oldevent"
|
||||||
|
auth_events:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: Event ID.
|
||||||
|
description: |-
|
||||||
|
Event IDs for the authorization events that would
|
||||||
|
allow this event to be in the room.
|
||||||
|
example: ["$URLsafe-base64EncodedHash", "$Another_Event"]
|
||||||
|
prev_events:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
description: Event ID.
|
||||||
|
description: |-
|
||||||
|
Event IDs for the most recent events in the room
|
||||||
|
that the homeserver was aware of when it made this event.
|
||||||
|
example: ["$URLsafe-base64EncodedHash", "$Another_Event"]
|
||||||
|
required:
|
||||||
|
- auth_events
|
||||||
|
- prev_events
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
# 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
|
||||||
|
allOf:
|
||||||
|
- $ref: "transaction.yaml"
|
||||||
|
properties:
|
||||||
|
pdus:
|
||||||
|
type: array
|
||||||
|
description: |-
|
||||||
|
A single PDU. Note that events have a different format depending on the room
|
||||||
|
version - check the `room version specification`_ for precise event formats.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: PDU
|
||||||
|
description: |-
|
||||||
|
The `PDUs <#pdus>`_ contained in the transaction. The event format varies depending
|
||||||
|
on the room version - check the `room version specification`_ for precise event formats.
|
||||||
|
properties: []
|
||||||
|
example:
|
||||||
|
$ref: "../examples/minimal_pdu.json"
|
||||||
|
required: ['origin', 'origin_server_ts', 'pdus']
|
||||||
@ -0,0 +1,33 @@
|
|||||||
|
# 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
|
||||||
|
allOf:
|
||||||
|
- $ref: "transaction.yaml"
|
||||||
|
properties:
|
||||||
|
pdus:
|
||||||
|
type: array
|
||||||
|
description: |-
|
||||||
|
List of persistent updates to rooms. Note that events have a different format
|
||||||
|
depending on the room version - check the `room version specification`_ for
|
||||||
|
precise event formats.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: PDU
|
||||||
|
description: |-
|
||||||
|
The `PDUs <#pdus>`_ contained in the transaction. The event format varies depending
|
||||||
|
on the room version - check the `room version specification`_ for precise event formats.
|
||||||
|
properties: []
|
||||||
|
example:
|
||||||
|
$ref: "../examples/minimal_pdu.json"
|
||||||
|
required: ['origin', 'origin_server_ts', 'pdus']
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"$ref": "pdu_v3.json",
|
||||||
|
"auth_events": [
|
||||||
|
"$urlsafe_base64_encoded_eventid",
|
||||||
|
"$a-different-event-id"
|
||||||
|
],
|
||||||
|
"prev_events": [
|
||||||
|
"$urlsafe_base64_encoded_eventid",
|
||||||
|
"$a-different-event-id"
|
||||||
|
],
|
||||||
|
"redacts": "$some-old_event"
|
||||||
|
}
|
||||||
@ -1 +0,0 @@
|
|||||||
Documented megolm session export format.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add missing status_msg to m.presence schema.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add support for advertising experimental features to clients.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add a generic SSO login API.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add a mechanism for servers to redirect clients to an alternative homeserver after logging in.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add room version upgrades.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Remove references to presence lists.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Support optional features by having clients query for capabilities.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Fix various spelling mistakes throughout the specification.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Fix various spelling mistakes throughout the specification.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Fix various spelling mistakes throughout the specification.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
``GET /account_data`` routes.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add ``M_RESOURCE_LIMIT_EXCEEDED`` as an error code for when homeservers exceed limits imposed on them.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add room version upgrades.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Support optional features by having clients query for capabilities.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Add the missing `m.push_rules` event schema.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Emit ``M_UNSUPPORTED_ROOM_VERSION`` error codes where applicable on ``/createRoom`` and ``/invite`` APIs.
|
|
||||||
@ -1 +0,0 @@
|
|||||||
Fix various spelling mistakes throughout the specification.
|
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Add missing format fields to ``m.room.message$m.notice`` schema.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Remove "required" designation from the ``url`` field of certain ``m.room.message`` msgtypes.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Fix typo in key verification framework section.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Clarify the distinction between ``m.key.verification.start`` and its ``m.sas.v1`` variant.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Fix link to Olm signing specification.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Fix various typos throughout the specification.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Fix a small duplicated "as".
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Clarify the conditions for the ``.m.rule.room_one_to_one`` push rule.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Clarify the encryption algorithms supported by the device of the device keys example.
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Clarify that ``/rooms/:roomId/event/:eventId`` returns a Matrix error.
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue