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.
81 lines
2.7 KiB
YAML
81 lines
2.7 KiB
YAML
3 years ago
|
# Copyright 2022 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 Client-Server Registration Token API"
|
||
|
|
version: "1.0.0"
|
||
|
|
host: localhost:8008
|
||
|
|
schemes:
|
||
|
|
- https
|
||
|
|
- http
|
||
|
|
basePath: /_matrix/client/v1
|
||
|
|
consumes:
|
||
|
|
- application/json
|
||
|
|
produces:
|
||
|
|
- application/json
|
||
|
|
paths:
|
||
|
|
"/register/m.login.registration_token/validity":
|
||
|
|
get:
|
||
|
|
x-addedInMatrixVersion: "1.2"
|
||
|
|
summary: Query if a given registration token is still valid.
|
||
|
|
description: |-
|
||
|
|
Queries the server to determine if a given registration token is still
|
||
|
|
valid at the time of request. This is a point-in-time check where the
|
||
|
|
token might still expire by the time it is used.
|
||
|
|
|
||
|
|
Servers should be sure to rate limit this endpoint to avoid brute force
|
||
|
|
attacks.
|
||
|
|
operationId: registrationTokenValidity
|
||
|
|
parameters:
|
||
|
|
- in: query
|
||
|
|
name: token
|
||
|
|
type: string
|
||
|
|
x-example: "fBVFdqVE"
|
||
|
|
required: true
|
||
|
|
description: The token to check validity of.
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: The check has a result.
|
||
|
|
examples:
|
||
|
|
application/json: {
|
||
|
|
"valid": true
|
||
|
|
}
|
||
|
|
schema:
|
||
|
|
type: object
|
||
|
|
properties:
|
||
|
|
valid:
|
||
|
|
type: boolean
|
||
|
|
description: |-
|
||
|
|
True if the token is still valid, false otherwise. This should
|
||
|
|
additionally be false if the token is not a recognised token by
|
||
|
|
the server.
|
||
|
|
required: ['valid']
|
||
|
|
403:
|
||
|
|
description: |-
|
||
|
|
The homeserver does not permit registration and thus all tokens are
|
||
|
|
considered invalid.
|
||
|
|
examples:
|
||
|
|
application/json: {
|
||
|
|
"errcode": "M_FORBIDDEN",
|
||
|
|
"error": "Registration is not enabled on this homeserver."
|
||
|
|
}
|
||
|
|
schema:
|
||
|
|
"$ref": "definitions/errors/error.yaml"
|
||
|
|
429:
|
||
|
|
description: This request was rate-limited.
|
||
|
|
schema:
|
||
|
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||
|
|
tags:
|
||
|
|
- Account management
|