mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
1c06ed9cf7
* Clarify that SSO login applies to the legacy authentication API Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Do not point to specific authentication API for obtaining access token Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Add warnings about incompatibility with OAuth 2.0 to endpoints that use UIA Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Add changelog Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Add note about API standards not applying to OAuth 2.0 Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> * Apply suggestions from code review --------- Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> Co-authored-by: Travis Ralston <travpc@gmail.com>
48 lines
1.6 KiB
YAML
48 lines
1.6 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.
|
|
accessTokenQuery:
|
|
type: apiKey
|
|
description: |-
|
|
**Deprecated.** The `access_token` obtained during [account registration](/client-server-api/#account-registration)
|
|
or [login](/client-server-api/#login), as a query parameter.
|
|
|
|
It can also be the `as_token` of an application service.
|
|
name: access_token
|
|
in: query
|
|
accessTokenBearer:
|
|
type: http
|
|
description: |-
|
|
The `access_token` obtained during [account registration](/client-server-api/#account-registration)
|
|
or [login](/client-server-api/#login), using the `Authorization: Bearer` header.
|
|
|
|
It can also be the `as_token` of an application service.
|
|
|
|
This is the preferred method.
|
|
scheme: bearer
|
|
appserviceAccessTokenQuery:
|
|
type: apiKey
|
|
description: |-
|
|
**Deprecated.** The `as_token` of an application service, as a query
|
|
parameter.
|
|
name: access_token
|
|
in: query
|
|
appserviceAccessTokenBearer:
|
|
type: http
|
|
description: |-
|
|
The `as_token` of an application service, using the `Authorization: Bearer`
|
|
header.
|
|
|
|
This is the preferred method.
|
|
scheme: bearer
|