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.
190 lines
7.0 KiB
YAML
190 lines
7.0 KiB
YAML
# Copyright 2016 OpenMarket 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.
|
|
swagger: '2.0'
|
|
info:
|
|
title: "Matrix Client-Server Registration and Login API"
|
|
version: "1.0.0"
|
|
host: localhost:8008
|
|
schemes:
|
|
- https
|
|
- http
|
|
basePath: /_matrix/client/%CLIENT_MAJOR_VERSION%
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
securityDefinitions:
|
|
$ref: definitions/security.yaml
|
|
paths:
|
|
"/login":
|
|
post:
|
|
summary: Authenticates the user.
|
|
description: |-
|
|
Authenticates the user, and issues an access token they can
|
|
use to authorize themself in subsequent requests.
|
|
parameters:
|
|
- in: body
|
|
name: body
|
|
schema:
|
|
type: object
|
|
example: |-
|
|
{
|
|
"type": "m.login.password",
|
|
"user": "cheeky_monkey",
|
|
"password": "ilovebananas"
|
|
}
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum: ["m.login.password", "m.login.token"]
|
|
description: The login type being used.
|
|
user:
|
|
type: string
|
|
description: The fully qualified user ID or just local part of the user ID, to log in.
|
|
medium:
|
|
type: string
|
|
description: When logging in using a third party identifier, the medium of the identifier. Must be 'email'.
|
|
address:
|
|
type: string
|
|
description: Third party identifier for the user.
|
|
password:
|
|
type: string
|
|
description: |-
|
|
Required when ``type`` is ``m.login.password``. The user's
|
|
password.
|
|
token:
|
|
type: string
|
|
description: |-
|
|
Required when ``type`` is ``m.login.token``. The login token.
|
|
required: ["type"]
|
|
|
|
responses:
|
|
200:
|
|
description: The user has been authenticated.
|
|
examples:
|
|
application/json: |-
|
|
{
|
|
"user_id": "@cheeky_monkey:matrix.org",
|
|
"access_token": "abc123",
|
|
"home_server": "matrix.org"
|
|
}
|
|
schema:
|
|
type: object
|
|
properties:
|
|
user_id:
|
|
type: string
|
|
description: The fully-qualified Matrix ID that has been registered.
|
|
access_token:
|
|
type: string
|
|
description: |-
|
|
An access token for the account.
|
|
This access token can then be used to authorize other requests.
|
|
The access token may expire at some point, and if so, it SHOULD come with a ``refresh_token``.
|
|
There is no specific error message to indicate that a request has failed because
|
|
an access token has expired; instead, if a client has reason to believe its
|
|
access token is valid, and it receives an auth error, they should attempt to
|
|
refresh for a new token on failure, and retry the request with the new token.
|
|
refresh_token:
|
|
type: string
|
|
description: |-
|
|
Optional. A ``refresh_token`` may be exchanged for a new ``access_token`` using the |/tokenrefresh|_ API endpoint.
|
|
home_server:
|
|
type: string
|
|
description: The hostname of the homeserver on which the account has been registered.
|
|
400:
|
|
description: |-
|
|
Part of the request was invalid. For example, the login type may not be recognised.
|
|
examples:
|
|
application/json: |-
|
|
{
|
|
"errcode": "M_UNKNOWN",
|
|
"error": "Bad login type."
|
|
}
|
|
403:
|
|
description: |-
|
|
The login attempt failed. For example, the password may have been incorrect.
|
|
examples:
|
|
application/json: |-
|
|
{"errcode": "M_FORBIDDEN"}
|
|
429:
|
|
description: This request was rate-limited.
|
|
schema:
|
|
"$ref": "definitions/error.yaml"
|
|
tags:
|
|
- Session management
|
|
"/tokenrefresh":
|
|
post:
|
|
summary: Exchanges a refresh token for an access token.
|
|
description: |-
|
|
Exchanges a refresh token for a new access token.
|
|
This is intended to be used if the access token has expired.
|
|
|
|
The server MUST invalidate the supplied ``refresh_token`` if the
|
|
request is successful. It MUST also invalidate the ``access_token``
|
|
which was issued at the same time as the ``refresh_token``, if it
|
|
has not already expired.
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: body
|
|
name: body
|
|
schema:
|
|
type: object
|
|
example: |-
|
|
{
|
|
"refresh_token": "a1b2c3"
|
|
}
|
|
properties:
|
|
refresh_token:
|
|
type: string
|
|
description: The refresh token which was issued by the server.
|
|
required: ["refresh_token"]
|
|
responses:
|
|
200:
|
|
description: |-
|
|
The refresh token was accepted, and a new access token has been issued.
|
|
The passed refresh token is no longer valid and cannot be used.
|
|
A new refresh token will have been returned unless some policy does
|
|
not allow the user to continue to renew their session.
|
|
examples:
|
|
application/json: |-
|
|
{
|
|
"access_token": "bearwithme123",
|
|
"refresh_token": "exchangewithme987"
|
|
}
|
|
schema:
|
|
type: object
|
|
properties:
|
|
access_token:
|
|
type: string
|
|
description: |-
|
|
An access token for the account.
|
|
This access token can then be used to authorize other requests.
|
|
The access token may expire at some point, and if so, it SHOULD come with a ``refresh_token``.
|
|
refresh_token:
|
|
type: string
|
|
description: Optional. A new ``refresh_token`` which may be exchanged for another new ``access_token``.
|
|
403:
|
|
description: |-
|
|
The exchange attempt failed. For example, the refresh token may have already been used.
|
|
examples:
|
|
application/json: |-
|
|
{"errcode": "M_FORBIDDEN"}
|
|
429:
|
|
description: This request was rate-limited.
|
|
schema:
|
|
"$ref": "definitions/error.yaml"
|
|
tags:
|
|
- Session management
|