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.
54 lines
2.0 KiB
YAML
54 lines
2.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 CAS Login API"
|
|
version: "1.0.0"
|
|
host: localhost:8008
|
|
schemes:
|
|
- https
|
|
- http
|
|
basePath: /_matrix/client/%CLIENT_MAJOR_VERSION%
|
|
paths:
|
|
"/login/cas/redirect":
|
|
get:
|
|
summary: Redirect the user's browser to the CAS interface.
|
|
description: |-
|
|
A web-based Matrix client should instruct the user's browser to
|
|
navigate to this endpoint in order to log in via CAS.
|
|
|
|
The server MUST respond with an HTTP redirect to the CAS interface. The
|
|
URI MUST include a ``service`` parameter giving the path of the
|
|
|/login/cas/ticket|_ endpoint (including the ``redirectUrl`` query
|
|
parameter).
|
|
|
|
For example, if the endpoint is called with
|
|
``redirectUrl=https://client.example.com/?q=p``, it might redirect to
|
|
``https://cas.example.com/?service=https%3A%2F%2Fserver.example.com%2F_matrix%2Fclient%2F%CLIENT_MAJOR_VERSION%%2Flogin%2Fcas%2Fticket%3FredirectUrl%3Dhttps%253A%252F%252Fclient.example.com%252F%253Fq%253Dp``.
|
|
|
|
parameters:
|
|
- in: query
|
|
type: string
|
|
name: redirectUrl
|
|
description: |-
|
|
URI to which the user will be redirected after the homeserver has
|
|
authenticated the user with CAS.
|
|
required: true
|
|
responses:
|
|
302:
|
|
description: A redirect to the CAS interface.
|
|
headers:
|
|
Location:
|
|
type: "string"
|