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.
47 lines
1.5 KiB
YAML
47 lines
1.5 KiB
YAML
6 years ago
|
# Copyright 2019 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.
|
||
|
swagger: '2.0'
|
||
|
info:
|
||
|
title: "Matrix Client-Server SSO Login API"
|
||
|
version: "1.0.0"
|
||
|
host: localhost:8008
|
||
|
schemes:
|
||
|
- https
|
||
|
- http
|
||
|
basePath: /_matrix/client/%CLIENT_MAJOR_VERSION%
|
||
|
paths:
|
||
|
"/login/sso/redirect":
|
||
|
get:
|
||
|
summary: Redirect the user's browser to the SSO interface.
|
||
|
description: |-
|
||
|
A web-based Matrix client should instruct the user's browser to
|
||
|
navigate to this endpoint in order to log in via SSO.
|
||
|
|
||
|
The server MUST respond with an HTTP redirect to the SSO interface.
|
||
|
operationId: redirectToSSO
|
||
|
parameters:
|
||
|
- in: query
|
||
|
type: string
|
||
|
name: redirectUrl
|
||
|
description: |-
|
||
|
URI to which the user will be redirected after the homeserver has
|
||
|
authenticated the user with SSO.
|
||
|
required: true
|
||
|
responses:
|
||
|
302:
|
||
|
description: A redirect to the SSO interface.
|
||
|
headers:
|
||
|
Location:
|
||
|
type: "string"
|