mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-01 16:54:09 +02:00
Add instructions on endpoints that should no longer be used
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
parent
839fd19b1a
commit
adcd6ba4a2
|
|
@ -1520,6 +1520,11 @@ client supports it, the client should redirect the user to the
|
||||||
is complete, the client will need to submit a `/login` request matching
|
is complete, the client will need to submit a `/login` request matching
|
||||||
`m.login.token`.
|
`m.login.token`.
|
||||||
|
|
||||||
|
{{% added-in v="1.17" %}} [OAuth 2.0 aware clients](/client-server-api/#oauth-20-aware-clients)
|
||||||
|
MUST only offer the `m.login.sso` flow to the user when `oauth_aware_preferred`
|
||||||
|
is set to `true` and MUST add the `action=login` parameter to the SSO redirect
|
||||||
|
endpoint.
|
||||||
|
|
||||||
{{% added-in v="1.7" %}} Already-authenticated clients can additionally generate
|
{{% added-in v="1.7" %}} Already-authenticated clients can additionally generate
|
||||||
a token for their user ID if supported by the homeserver using
|
a token for their user ID if supported by the homeserver using
|
||||||
[`POST /login/get_token`](/client-server-api/#post_matrixclientv1loginget_token).
|
[`POST /login/get_token`](/client-server-api/#post_matrixclientv1loginget_token).
|
||||||
|
|
|
||||||
|
|
@ -35,6 +35,14 @@ paths:
|
||||||
Unlike other endpoints, this endpoint does not take an `id_access_token`
|
Unlike other endpoints, this endpoint does not take an `id_access_token`
|
||||||
parameter because the homeserver is expected to sign the request to the
|
parameter because the homeserver is expected to sign the request to the
|
||||||
identity server instead.
|
identity server instead.
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
{{% added-in v="1.17" %}} [OAuth 2.0 aware clients](/client-server-api/#oauth-20-aware-clients)
|
||||||
|
MUST NOT use this endpoint when the server supports the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
Instead they MUST refer the user to the [account management URL](/client-server-api/#oauth-20-account-management),
|
||||||
|
if available, and MAY use the `action=org.matrix.account_deactivate`
|
||||||
|
parameter.
|
||||||
|
{{% /boxes/warning %}}
|
||||||
security:
|
security:
|
||||||
- {}
|
- {}
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -142,6 +142,13 @@ paths:
|
||||||
Since this endpoint uses User-Interactive Authentication, it cannot be used when the access token was obtained
|
Since this endpoint uses User-Interactive Authentication, it cannot be used when the access token was obtained
|
||||||
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
{{% /boxes/warning %}}
|
{{% /boxes/warning %}}
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
{{% added-in v="1.17" %}} [OAuth 2.0 aware clients](/client-server-api/#oauth-20-aware-clients)
|
||||||
|
MUST NOT use this endpoint when the server supports the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
Instead they MUST refer the user to the [account management URL](/client-server-api/#oauth-20-account-management),
|
||||||
|
if available, with the `action=org.matrix.device_delete` and `device_id={deviceId}` parameters.
|
||||||
|
{{% /boxes/warning %}}
|
||||||
operationId: deleteDevice
|
operationId: deleteDevice
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
@ -199,6 +206,13 @@ paths:
|
||||||
Since this endpoint uses User-Interactive Authentication, it cannot be used when the access token was obtained
|
Since this endpoint uses User-Interactive Authentication, it cannot be used when the access token was obtained
|
||||||
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
{{% /boxes/warning %}}
|
{{% /boxes/warning %}}
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
{{% added-in v="1.17" %}} [OAuth 2.0 aware clients](/client-server-api/#oauth-20-aware-clients)
|
||||||
|
MUST NOT use this endpoint when the server supports the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
Instead they MUST refer the user to the [account management URL](/client-server-api/#oauth-20-account-management),
|
||||||
|
if available.
|
||||||
|
{{% /boxes/warning %}}
|
||||||
operationId: deleteDevices
|
operationId: deleteDevices
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -60,6 +60,14 @@ paths:
|
||||||
|
|
||||||
Any user ID returned by this API must conform to the grammar given in the
|
Any user ID returned by this API must conform to the grammar given in the
|
||||||
[Matrix specification](/appendices/#user-identifiers).
|
[Matrix specification](/appendices/#user-identifiers).
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
{{% added-in v="1.17" %}} [OAuth 2.0 aware clients](/client-server-api/#oauth-20-aware-clients)
|
||||||
|
MUST NOT use this endpoint when the server offers the [`m.login.sso`
|
||||||
|
authentication flow](/client-server-api/#client-login-via-sso) with
|
||||||
|
`oauth_aware_preferred` set to `true`. Instead they MUST add the
|
||||||
|
`action=register` parameter to the SSO redirect endpoint.
|
||||||
|
{{% /boxes/warning %}}
|
||||||
operationId: register
|
operationId: register
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue