mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-30 14:14:09 +02:00
Compare commits
9 commits
60e64d8082
...
1260fad6fa
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1260fad6fa | ||
|
|
fa78688f57 | ||
|
|
6e7c8a6da0 | ||
|
|
edea11e610 | ||
|
|
c8ae75a342 | ||
|
|
70d2005743 | ||
|
|
293012d12f | ||
|
|
80c6ffd1d8 | ||
|
|
8350b88a3d |
1
changelogs/client_server/newsfragments/2270.feature
Normal file
1
changelogs/client_server/newsfragments/2270.feature
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add the account management capabilities for the OAuth 2.0 authentication API, as per [MSC4191](https://github.com/matrix-org/matrix-spec-proposals/pull/4191).
|
||||||
1
changelogs/client_server/newsfragments/2291.feature
Normal file
1
changelogs/client_server/newsfragments/2291.feature
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Add `m.recent_emoji` account data event to track recently used emoji as per [MSC4356](https://github.com/matrix-org/matrix-spec-proposals/pull/4356).
|
||||||
|
|
@ -645,7 +645,7 @@ manage their account like [changing their password](#password-management),
|
||||||
[deactivating their account](#account-deactivation).
|
[deactivating their account](#account-deactivation).
|
||||||
|
|
||||||
With the OAuth 2.0 API, all account management is done via the homeserver's web
|
With the OAuth 2.0 API, all account management is done via the homeserver's web
|
||||||
UI.
|
UI that can be accessed by users via the [account management URL](#oauth-20-account-management).
|
||||||
|
|
||||||
### Legacy API
|
### Legacy API
|
||||||
|
|
||||||
|
|
@ -2271,6 +2271,54 @@ The server SHOULD return one of the following responses:
|
||||||
- For other errors, the server returns a `400 Bad Request` response with error
|
- For other errors, the server returns a `400 Bad Request` response with error
|
||||||
details
|
details
|
||||||
|
|
||||||
|
#### Account management {id="oauth-20-account-management"}
|
||||||
|
|
||||||
|
{{% added-in v="1.18" %}}
|
||||||
|
|
||||||
|
All account management is done via the homeserver's web UI.
|
||||||
|
|
||||||
|
This specification defines extensions to the [OAuth Authorization Server
|
||||||
|
Metadata registry](https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml#authorization-server-metadata)
|
||||||
|
to offer clients a way to deep-link to the account management capabilities of
|
||||||
|
the homeserver to allow the user to complete the account management operations
|
||||||
|
in a browser.
|
||||||
|
|
||||||
|
##### Account management URL discovery
|
||||||
|
|
||||||
|
The [OAuth 2.0 authorization server metadata](#server-metadata-discovery) is
|
||||||
|
extended to include the following fields:
|
||||||
|
|
||||||
|
| Field | Description |
|
||||||
|
|----------------------------------------|-------------------------------------------------------------------------------------------------|
|
||||||
|
| `account_management_uri` | The URL where the user is able to access the account management capabilities of the homeserver. |
|
||||||
|
| `account_management_actions_supported` | An array of actions that the account management URL supports, as defined below. |
|
||||||
|
|
||||||
|
##### Account management URL parameters
|
||||||
|
|
||||||
|
The account management URL MAY accept the following query parameters:
|
||||||
|
|
||||||
|
| Parameter | Description |
|
||||||
|
|-------------|---------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| `action` | **Optional**. The action that the user wishes to take. Must match one of the actions in `account_management_actions_supported` above. |
|
||||||
|
| `device_id` | **Optional**. Identifies a particular Matrix device ID for actions that support it. |
|
||||||
|
|
||||||
|
If the `org.matrix.device_view` or `org.matrix.device_delete` actions are
|
||||||
|
advertised as supported by the server then the server SHOULD support the
|
||||||
|
`device_id` parameter.
|
||||||
|
|
||||||
|
##### Account management URL actions
|
||||||
|
|
||||||
|
The following account management actions are defined:
|
||||||
|
|
||||||
|
| Action | Description |
|
||||||
|
|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| `org.matrix.profile` | The user wishes to view/edit their profile (name, avatar, contact details). |
|
||||||
|
| `org.matrix.devices_list` | The user wishes to view a list of their devices. |
|
||||||
|
| `org.matrix.device_view` | The user wishes to view the details of a specific device. A `device_id` SHOULD be provided. |
|
||||||
|
| `org.matrix.device_delete` | The user wishes to delete/log out a specific device. A `device_id` SHOULD be provided. |
|
||||||
|
| `org.matrix.account_deactivate` | The user wishes to deactivate their account. |
|
||||||
|
| `org.matrix.cross_signing_reset` | The user wishes to reset their cross-signing identity. Servers SHOULD use this action in the URL of the [`m.oauth`](#oauth-authentication) UIA type. |
|
||||||
|
|
||||||
### Account moderation
|
### Account moderation
|
||||||
|
|
||||||
#### Account locking
|
#### Account locking
|
||||||
|
|
@ -3898,6 +3946,7 @@ that profile.
|
||||||
| [Guest Access](#guest-access) | Optional | Optional | Optional | Optional | Optional |
|
| [Guest Access](#guest-access) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Moderation Policy Lists](#moderation-policy-lists) | Optional | Optional | Optional | Optional | Optional |
|
| [Moderation Policy Lists](#moderation-policy-lists) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [OpenID](#openid) | Optional | Optional | Optional | Optional | Optional |
|
| [OpenID](#openid) | Optional | Optional | Optional | Optional | Optional |
|
||||||
|
| [Recently used emoji](#recently-used-emoji) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Reference Relations](#reference-relations) | Optional | Optional | Optional | Optional | Optional |
|
| [Reference Relations](#reference-relations) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Reporting Content](#reporting-content) | Optional | Optional | Optional | Optional | Optional |
|
| [Reporting Content](#reporting-content) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Rich replies](#rich-replies) | Optional | Optional | Optional | Optional | Optional |
|
| [Rich replies](#rich-replies) | Optional | Optional | Optional | Optional | Optional |
|
||||||
|
|
@ -3999,5 +4048,6 @@ systems.
|
||||||
{{% cs-module name="Spaces" filename="spaces" %}}
|
{{% cs-module name="Spaces" filename="spaces" %}}
|
||||||
{{% cs-module name="Event replacements" filename="event_replacements" %}}
|
{{% cs-module name="Event replacements" filename="event_replacements" %}}
|
||||||
{{% cs-module name="Event annotations and reactions" filename="event_annotations" %}}
|
{{% cs-module name="Event annotations and reactions" filename="event_annotations" %}}
|
||||||
|
{{% cs-module name="Recently used emoji" filename="recent_emoji" %}}
|
||||||
{{% cs-module name="Threading" filename="threading" %}}
|
{{% cs-module name="Threading" filename="threading" %}}
|
||||||
{{% cs-module name="Reference relations" filename="reference_relations" %}}
|
{{% cs-module name="Reference relations" filename="reference_relations" %}}
|
||||||
|
|
|
||||||
40
content/client-server-api/modules/recent_emoji.md
Normal file
40
content/client-server-api/modules/recent_emoji.md
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
### Recently used emoji
|
||||||
|
|
||||||
|
{{% added-in v="1.18" %}}
|
||||||
|
|
||||||
|
This module enables clients to track a user's cumulated emoji usage across different
|
||||||
|
devices. The data is stored in the [`m.recent_emoji`](#mrecent_emoji)
|
||||||
|
global [account data](#client-config) and can, among other things, be used to
|
||||||
|
generate recommendations in emoji pickers.
|
||||||
|
|
||||||
|
#### Events
|
||||||
|
|
||||||
|
{{% event event="m.recent_emoji" %}}
|
||||||
|
|
||||||
|
#### Client behaviour
|
||||||
|
|
||||||
|
What exactly constitutes trackable emoji usage is left as an implementation detail
|
||||||
|
for clients. It is RECOMMENDED to include sending emoji in both messages and
|
||||||
|
annotations.
|
||||||
|
|
||||||
|
When an emoji is used, the sending client moves (or adds) it to the beginning of
|
||||||
|
the `recent_emoji` array and increments (or initializes) its counter. This keeps
|
||||||
|
the array ordered by last usage time which facilitates evaluating the data. How
|
||||||
|
exactly the client evaluates and uses the collected data is deliberately left
|
||||||
|
unspecified.
|
||||||
|
|
||||||
|
To prevent excessive growth of the event as new emoji are being used, clients
|
||||||
|
SHOULD limit the length of the `recent_emoji` array by dropping elements from
|
||||||
|
its end. A RECOMMENDED maximum length is 100 emoji.
|
||||||
|
|
||||||
|
To enable future extension, clients MUST tolerate and preserve array elements
|
||||||
|
within `recent_emoji` regardless of whether they understand or support the
|
||||||
|
contained `emoji` value. This means ignoring entries with unrecognised values
|
||||||
|
of `emoji` when deciding what to display to the user while retaining them when
|
||||||
|
modifying the array (unless the modification is for truncation).
|
||||||
|
|
||||||
|
To prevent undefined behavior, clients SHOULD remove array elements that
|
||||||
|
don't conform to the event schema such as elements with negative counters.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
29
data/api/client-server/definitions/recent_emoji.yaml
Normal file
29
data/api/client-server/definitions/recent_emoji.yaml
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
# Copyright 2026 The Matrix.org Foundation C.I.C.
|
||||||
|
#
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
title: Recent Emoji
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
emoji:
|
||||||
|
type: string
|
||||||
|
description: The Unicode emoji as string.
|
||||||
|
example: 🚀
|
||||||
|
total:
|
||||||
|
type: number
|
||||||
|
description: |-
|
||||||
|
The number of times the emoji has been used.
|
||||||
|
MUST be non-negative and smaller than 2^53.
|
||||||
|
required:
|
||||||
|
- emoji
|
||||||
|
- total
|
||||||
|
|
@ -139,6 +139,32 @@ paths:
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
description: A prompt value that the server supports.
|
description: A prompt value that the server supports.
|
||||||
|
account_management_uri:
|
||||||
|
x-addedInMatrixVersion: "1.18"
|
||||||
|
type: string
|
||||||
|
format: uri
|
||||||
|
description: |-
|
||||||
|
The URL where the user is able to access the account management capabilities
|
||||||
|
of the homeserver.
|
||||||
|
|
||||||
|
This is an extension [defined in this specification](/client-server-api/#oauth-20-account-management).
|
||||||
|
account_management_actions_supported:
|
||||||
|
x-addedInMatrixVersion: "1.18"
|
||||||
|
type: array
|
||||||
|
description: |-
|
||||||
|
List of actions that the account management URL supports.
|
||||||
|
|
||||||
|
This is an extension [defined in this specification](/client-server-api/#oauth-20-account-management).
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- "org.matrix.profile"
|
||||||
|
- "org.matrix.devices_list"
|
||||||
|
- "org.matrix.device_view"
|
||||||
|
- "org.matrix.device_delete"
|
||||||
|
- "org.matrix.account_deactivate"
|
||||||
|
- "org.matrix.cross_signing_reset"
|
||||||
|
description: An action that the account management URL supports.
|
||||||
required:
|
required:
|
||||||
- issuer
|
- issuer
|
||||||
- authorization_endpoint
|
- authorization_endpoint
|
||||||
|
|
@ -159,6 +185,15 @@ paths:
|
||||||
"grant_types_supported": ["authorization_code", "refresh_token"],
|
"grant_types_supported": ["authorization_code", "refresh_token"],
|
||||||
"response_modes_supported": ["query", "fragment"],
|
"response_modes_supported": ["query", "fragment"],
|
||||||
"code_challenge_methods_supported": ["S256"],
|
"code_challenge_methods_supported": ["S256"],
|
||||||
|
"account_management_uri": "https://account.example.com/manage",
|
||||||
|
"account_management_actions_supported": [
|
||||||
|
"org.matrix.profile",
|
||||||
|
"org.matrix.devices_list",
|
||||||
|
"org.matrix.device_view",
|
||||||
|
"org.matrix.device_delete",
|
||||||
|
"org.matrix.account_deactivate",
|
||||||
|
"org.matrix.cross_signing_reset",
|
||||||
|
],
|
||||||
}
|
}
|
||||||
tags:
|
tags:
|
||||||
- Session management
|
- Session management
|
||||||
|
|
|
||||||
16
data/event-schemas/examples/m.recent_emoji.yaml
Normal file
16
data/event-schemas/examples/m.recent_emoji.yaml
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
{
|
||||||
|
"$ref": "core/event.json",
|
||||||
|
"type": "m.recent_emoji",
|
||||||
|
"content": {
|
||||||
|
"recent_emoji": [{
|
||||||
|
"emoji": "🤔",
|
||||||
|
"total": 19
|
||||||
|
}, {
|
||||||
|
"emoji": "👍",
|
||||||
|
"total": 7
|
||||||
|
}, {
|
||||||
|
"emoji": "😅",
|
||||||
|
"total": 84
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
}
|
||||||
29
data/event-schemas/schema/m.recent_emoji.yaml
Normal file
29
data/event-schemas/schema/m.recent_emoji.yaml
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
{
|
||||||
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
|
"type": "object",
|
||||||
|
"title": "Recent Emoji Event",
|
||||||
|
"description": "Lets clients maintain a list of recently used emoji.",
|
||||||
|
"allOf": [{
|
||||||
|
"$ref": "core-event-schema/event.yaml"
|
||||||
|
}],
|
||||||
|
"properties": {
|
||||||
|
"type": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["m.recent_emoji"]
|
||||||
|
},
|
||||||
|
"content": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"recent_emoji": {
|
||||||
|
"description": "The list of recently used emoji. Elements in the list are ordered descendingly by last usage time.",
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "../../api/client-server/definitions/recent_emoji.yaml"
|
||||||
|
},
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": ["recent_emoji"]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": ["type", "content"]
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue