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.
104 lines
3.6 KiB
YAML
104 lines
3.6 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
# Copyright 2018 New Vector Ltd
|
|
#
|
|
# 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.
|
|
openapi: 3.1.0
|
|
info:
|
|
title: Matrix Application Service API
|
|
version: 1.0.0
|
|
paths:
|
|
"/users/{userId}":
|
|
get:
|
|
summary: Query if a user should exist on the application service.
|
|
description: |-
|
|
This endpoint is invoked by the homeserver on an application service to query
|
|
the existence of a given user ID. The homeserver will only query user IDs
|
|
inside the application service's `users` namespace. The homeserver will
|
|
send this request when it receives an event for an unknown user ID in
|
|
the application service's namespace, such as a room invite.
|
|
operationId: queryUserById
|
|
security:
|
|
- homeserverAccessToken: []
|
|
parameters:
|
|
- in: path
|
|
name: userId
|
|
description: The user ID being queried.
|
|
required: true
|
|
example: "@alice:example.com"
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: |-
|
|
The application service indicates that this user exists. The application
|
|
service MUST create the user using the client-server API.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
examples:
|
|
response:
|
|
value: {}
|
|
"401":
|
|
description: |-
|
|
The homeserver has not supplied credentials to the application service.
|
|
Optional error information can be included in the body of this response.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
examples:
|
|
response:
|
|
value: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_UNAUTHORIZED"
|
|
}
|
|
"403":
|
|
description: The credentials supplied by the homeserver were rejected.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
examples:
|
|
response:
|
|
value: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_FORBIDDEN"
|
|
}
|
|
"404":
|
|
description: |-
|
|
The application service indicates that this user does not exist.
|
|
Optional error information can be included in the body of this response.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../client-server/definitions/errors/error.yaml
|
|
examples:
|
|
response:
|
|
value: {
|
|
"errcode": "COM.EXAMPLE.MYAPPSERVICE_NOT_FOUND"
|
|
}
|
|
servers:
|
|
- url: "{protocol}://{hostname}{basePath}"
|
|
variables:
|
|
protocol:
|
|
enum:
|
|
- http
|
|
- https
|
|
default: https
|
|
hostname:
|
|
default: localhost:8008
|
|
basePath:
|
|
default: /_matrix/app/v1
|
|
components:
|
|
securitySchemes:
|
|
$ref: definitions/security.yaml
|