mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-22 14:03:42 +01:00
Add warnings about incompatibility with OAuth 2.0 to endpoints that use UIA
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
parent
e864a20025
commit
8464edcb2d
|
|
@ -201,6 +201,11 @@ paths:
|
||||||
|
|
||||||
Homeservers should prevent the caller from adding a 3PID to their account if it has
|
Homeservers should prevent the caller from adding a 3PID to their account if it has
|
||||||
already been added to another user's account on the homeserver.
|
already been added to another user's account on the homeserver.
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
Since this endpoint uses UIA, it cannot be used when the access token was obtained
|
||||||
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
{{% /boxes/warning %}}
|
||||||
operationId: add3PID
|
operationId: add3PID
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ paths:
|
||||||
Publishes cross-signing keys for the user.
|
Publishes cross-signing keys for the user.
|
||||||
|
|
||||||
This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
||||||
|
|
||||||
User-Interactive Authentication MUST be performed, except in these cases:
|
User-Interactive Authentication MUST be performed, except in these cases:
|
||||||
- there is no existing cross-signing master key uploaded to the homeserver, OR
|
- there is no existing cross-signing master key uploaded to the homeserver, OR
|
||||||
- there is an existing cross-signing master key and it exactly matches the
|
- there is an existing cross-signing master key and it exactly matches the
|
||||||
|
|
@ -34,11 +34,16 @@ paths:
|
||||||
keys provided in the request (self-signing key, user-signing key) they MUST also
|
keys provided in the request (self-signing key, user-signing key) they MUST also
|
||||||
match the existing keys stored on the server. In other words, the request contains
|
match the existing keys stored on the server. In other words, the request contains
|
||||||
no new keys.
|
no new keys.
|
||||||
|
|
||||||
This allows clients to freely upload one set of keys, but not modify/overwrite keys if
|
This allows clients to freely upload one set of keys, but not modify/overwrite keys if
|
||||||
they already exist. Allowing clients to upload the same set of keys more than once
|
they already exist. Allowing clients to upload the same set of keys more than once
|
||||||
makes this endpoint idempotent in the case where the response is lost over the network,
|
makes this endpoint idempotent in the case where the response is lost over the network,
|
||||||
which would otherwise cause a UIA challenge upon retry.
|
which would otherwise cause a UIA challenge upon retry.
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
When this endpoint requires UIA, it cannot be used when the access token was obtained
|
||||||
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
{{% /boxes/warning %}}
|
||||||
operationId: uploadCrossSigningKeys
|
operationId: uploadCrossSigningKeys
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -137,6 +137,11 @@ paths:
|
||||||
This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
||||||
|
|
||||||
Deletes the given device, and invalidates any access token associated with it.
|
Deletes the given device, and invalidates any access token associated with it.
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
Since this endpoint uses UIA, it cannot be used when the access token was obtained
|
||||||
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
{{% /boxes/warning %}}
|
||||||
operationId: deleteDevice
|
operationId: deleteDevice
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
@ -189,6 +194,11 @@ paths:
|
||||||
This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
||||||
|
|
||||||
Deletes the given devices, and invalidates any access token associated with them.
|
Deletes the given devices, and invalidates any access token associated with them.
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
Since this endpoint uses UIA, it cannot be used when the access token was obtained
|
||||||
|
via the [OAuth 2.0 API](/client-server-api/#oauth-20-api).
|
||||||
|
{{% /boxes/warning %}}
|
||||||
operationId: deleteDevices
|
operationId: deleteDevices
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue