Document m.get_login_token capability (#1908)
This commit is contained in:
parent
149d5d2a95
commit
d9c447e194
4 changed files with 29 additions and 3 deletions
|
@ -0,0 +1 @@
|
||||||
|
Document the `m.get_login_token` capability as per [MSC3882](https://github.com/matrix-org/matrix-spec-proposals/pull/3882).
|
|
@ -1654,6 +1654,27 @@ An example of the capability API's response for this capability is:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### `m.get_login_token` capability
|
||||||
|
|
||||||
|
This capability has a single flag, `enabled`, to denote whether the user
|
||||||
|
is able to use [`POST /login/get_token`](/client-server-api/#post_matrixclientv1loginget_token)
|
||||||
|
to generate single-use, time-limited tokens to log unauthenticated clients
|
||||||
|
into their account.
|
||||||
|
|
||||||
|
When not listed, clients SHOULD assume the user is unable to generate tokens.
|
||||||
|
|
||||||
|
An example of the capability API's response for this capability is:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"capabilities": {
|
||||||
|
"m.get_login_token": {
|
||||||
|
"enabled": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Filtering
|
## Filtering
|
||||||
|
|
||||||
Filters can be created on the server and can be passed as a parameter to
|
Filters can be created on the server and can be passed as a parameter to
|
||||||
|
|
|
@ -80,6 +80,10 @@ paths:
|
||||||
$ref: '#/components/schemas/booleanCapability'
|
$ref: '#/components/schemas/booleanCapability'
|
||||||
description: Capability to indicate if the user can change 3PID associations
|
description: Capability to indicate if the user can change 3PID associations
|
||||||
on their account.
|
on their account.
|
||||||
|
m.get_login_token:
|
||||||
|
$ref: '#/components/schemas/booleanCapability'
|
||||||
|
description: Capability to indicate if the user can generate tokens to log further
|
||||||
|
clients into their account.
|
||||||
examples:
|
examples:
|
||||||
response:
|
response:
|
||||||
value: {
|
value: {
|
||||||
|
|
|
@ -33,7 +33,7 @@ paths:
|
||||||
|
|
||||||
Clients, both authenticated and unauthenticated, might wish to hide user interface which exposes
|
Clients, both authenticated and unauthenticated, might wish to hide user interface which exposes
|
||||||
this feature if the server is not offering it. Authenticated clients can check for support on
|
this feature if the server is not offering it. Authenticated clients can check for support on
|
||||||
a per-user basis with the `m.get_login_token` [capability](/client-server-api/#capabilities-negotiation),
|
a per-user basis with the [`m.get_login_token`](/client-server-api/#mget_login_token-capability) capability,
|
||||||
while unauthenticated clients can detect server support by looking for an `m.login.token` login
|
while unauthenticated clients can detect server support by looking for an `m.login.token` login
|
||||||
flow with `get_login_token: true` on [`GET /login`](/client-server-api/#post_matrixclientv3login).
|
flow with `get_login_token: true` on [`GET /login`](/client-server-api/#post_matrixclientv3login).
|
||||||
|
|
||||||
|
@ -98,8 +98,8 @@ paths:
|
||||||
The request was malformed, or the user does not have an ability to generate tokens for their devices,
|
The request was malformed, or the user does not have an ability to generate tokens for their devices,
|
||||||
as implied by the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
as implied by the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
|
||||||
|
|
||||||
Clients should verify whether the user has an ability to call this endpoint with the `m.get_login_token`
|
Clients should verify whether the user has an ability to call this endpoint with the
|
||||||
[capability](/client-server-api/#capabilities-negotiation).
|
[`m.get_login_token`](/client-server-api/#mget_login_token-capability) capability.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue