mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-12 22:44:09 +01:00
Compare commits
3 commits
d858df22e8
...
2f2049b854
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2f2049b854 | ||
|
|
c8c2110c3b | ||
|
|
fe6c97f498 |
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).
|
||||
|
|
@ -0,0 +1 @@
|
|||
Specified input validation for PDUs passed to federation membership endpoints.
|
||||
|
|
@ -645,7 +645,7 @@ manage their account like [changing their password](#password-management),
|
|||
[deactivating their account](#account-deactivation).
|
||||
|
||||
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
|
||||
|
||||
|
|
@ -2271,6 +2271,46 @@ The server SHOULD return one of the following responses:
|
|||
- For other errors, the server returns a `400 Bad Request` response with error
|
||||
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 **optional** fields.
|
||||
|
||||
{{% definition path="schemas/oauth2-account-management-server-metadata" %}}
|
||||
|
||||
##### Account management URL parameters
|
||||
|
||||
The account management URL MAY accept the following minimum query parameters.
|
||||
|
||||
{{% definition path="schemas/oauth2-account-management-url" %}}
|
||||
|
||||
##### Account management URL actions
|
||||
|
||||
Account management actions are unique to the application. They SHOULD follow the
|
||||
[Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar)
|
||||
where feasible. The Matrix-specific actions are:
|
||||
|
||||
| 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 locking
|
||||
|
|
|
|||
|
|
@ -139,6 +139,32 @@ paths:
|
|||
items:
|
||||
type: string
|
||||
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:
|
||||
- issuer
|
||||
- authorization_endpoint
|
||||
|
|
@ -159,6 +185,15 @@ paths:
|
|||
"grant_types_supported": ["authorization_code", "refresh_token"],
|
||||
"response_modes_supported": ["query", "fragment"],
|
||||
"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:
|
||||
- Session management
|
||||
|
|
|
|||
|
|
@ -172,6 +172,17 @@ paths:
|
|||
}
|
||||
"400":
|
||||
description: |-
|
||||
The `M_INVALID_PARAM` error code is used to indicate one or more of the following:
|
||||
|
||||
* The invite event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||
* The event type is not `m.room.member`.
|
||||
* The `membership` field inside the event content is not `invite`.
|
||||
* The event sender is not a user ID on the origin server.
|
||||
* The `state_key` is not a user ID on the receiving server.
|
||||
|
||||
Servers MUST apply the validation above to the invite event before
|
||||
signing it regardless of room version.
|
||||
|
||||
The `M_MISSING_PARAM` error code is used to indicate one or more of
|
||||
the following:
|
||||
|
||||
|
|
@ -186,9 +197,9 @@ paths:
|
|||
Servers MAY apply the validation above to room versions 1 through 11,
|
||||
and SHOULD apply the validation above to all other room versions.
|
||||
|
||||
If `M_MISSING_PARAM` is returned and the request is associated with a
|
||||
Client-Server API request, the Client-Server API request SHOULD fail
|
||||
with a 5xx error rather than being passed through.
|
||||
If `M_MISSING_PARAM` or `M_INVALID_PARAM` is returned and the request
|
||||
is associated with a Client-Server API request, the Client-Server API
|
||||
request SHOULD fail with a 5xx error rather than being passed through.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -154,6 +154,17 @@ paths:
|
|||
The error should be passed through to clients so that they
|
||||
may give better feedback to users.
|
||||
|
||||
The `M_INVALID_PARAM` error code is used to indicate one or more of the following:
|
||||
|
||||
* The invite event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||
* The event type is not `m.room.member`.
|
||||
* The `membership` field inside the event content is not `invite`.
|
||||
* The event sender is not a user ID on the origin server.
|
||||
* The `state_key` is not a user ID on the receiving server.
|
||||
|
||||
Servers MUST apply the validation above to the invite event before
|
||||
signing it regardless of room version.
|
||||
|
||||
The `M_MISSING_PARAM` error code is used to indicate one or more of
|
||||
the following:
|
||||
|
||||
|
|
@ -168,9 +179,9 @@ paths:
|
|||
Servers MAY apply the validation above to room versions 1 through 11,
|
||||
and SHOULD apply the validation above to all other room versions.
|
||||
|
||||
If `M_MISSING_PARAM` is returned and the request is associated with a
|
||||
Client-Server API request, the Client-Server API request SHOULD fail
|
||||
with a 5xx error rather than being passed through.
|
||||
If `M_MISSING_PARAM` or `M_INVALID_PARAM` is returned and the request
|
||||
is associated with a Client-Server API request, the Client-Server API
|
||||
request SHOULD fail with a 5xx error rather than being passed through.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ paths:
|
|||
type: string
|
||||
- in: path
|
||||
name: userId
|
||||
description: The user ID the join event will be for.
|
||||
description: The user ID the join event will be for. This MUST be a user ID on the origin server.
|
||||
required: true
|
||||
example: "@someone:example.org"
|
||||
schema:
|
||||
|
|
@ -388,6 +388,43 @@ paths:
|
|||
}
|
||||
}
|
||||
]
|
||||
"400":
|
||||
description: |-
|
||||
The request is invalid in some way.
|
||||
|
||||
The `M_INVALID_PARAM` error code is used to indicate one or more of the following:
|
||||
|
||||
* The join event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||
* The event type is not `m.room.member`.
|
||||
* The `membership` field inside the event content is not `join`.
|
||||
* The event sender is not a user ID on the origin server.
|
||||
* The `state_key` is not equal to the `sender`.
|
||||
|
||||
Servers MUST apply the validation above to the join event.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../client-server/definitions/errors/error.yaml
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
"errcode": "M_INVALID_PARAM",
|
||||
"error": "Not a join event."
|
||||
}
|
||||
"403":
|
||||
description: |-
|
||||
The room that the joining server is attempting to join does not permit the user
|
||||
to join.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../client-server/definitions/errors/error.yaml
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
"errcode": "M_FORBIDDEN",
|
||||
"error": "You are not invited to this room"
|
||||
}
|
||||
servers:
|
||||
- url: "{protocol}://{hostname}{basePath}"
|
||||
variables:
|
||||
|
|
|
|||
|
|
@ -247,6 +247,16 @@ paths:
|
|||
The error should be passed through to clients so that they
|
||||
may give better feedback to users.
|
||||
|
||||
The `M_INVALID_PARAM` error code is used to indicate one or more of the following:
|
||||
|
||||
* The join event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||
* The event type is not `m.room.member`.
|
||||
* The `membership` field inside the event content is not `join`.
|
||||
* The event sender is not a user ID on the origin server.
|
||||
* The `state_key` is not equal to the `sender`.
|
||||
|
||||
Servers MUST apply the validation above to the join event.
|
||||
|
||||
New in `v1.2`, the following error conditions might happen:
|
||||
|
||||
If the room is [restricted](/client-server-api/#restricted-rooms)
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ paths:
|
|||
type: string
|
||||
- in: path
|
||||
name: userId
|
||||
description: The user ID the knock event will be for.
|
||||
description: The user ID the knock event will be for. This MUST be a user ID on the origin server.
|
||||
required: true
|
||||
example: "@someone:example.org"
|
||||
schema:
|
||||
|
|
@ -330,6 +330,27 @@ paths:
|
|||
"$ref": "./examples/invite_or_knock_state.json"
|
||||
}
|
||||
}
|
||||
"400":
|
||||
description: |-
|
||||
The `M_INVALID_PARAM` error code is used to indicate one or more of the following:
|
||||
|
||||
* The knock event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||
* The event type is not `m.room.member`.
|
||||
* The `membership` field inside the event content is not `knock`.
|
||||
* The event sender is not a user ID on the origin server.
|
||||
* The `state_key` is not equal to the `sender`.
|
||||
|
||||
Servers MUST apply the validation above to the knock event.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../client-server/definitions/errors/error.yaml
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
"errcode": "M_INVALID_PARAM",
|
||||
"error": "Not a knock event."
|
||||
}
|
||||
"403":
|
||||
description: |-
|
||||
The knocking server or user is not permitted to knock on the room, such as when the
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ paths:
|
|||
type: string
|
||||
- in: path
|
||||
name: userId
|
||||
description: The user ID the leave event will be for.
|
||||
description: The user ID the leave event will be for. This MUST be a user ID on the origin server.
|
||||
required: true
|
||||
example: "@someone:example.org"
|
||||
schema:
|
||||
|
|
@ -249,6 +249,27 @@ paths:
|
|||
200,
|
||||
{}
|
||||
]
|
||||
"400":
|
||||
description: |-
|
||||
The `M_INVALID_PARAM` error code is used to indicate one or more of the following:
|
||||
|
||||
* The leave event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||
* The event type is not `m.room.member`.
|
||||
* The `membership` field inside the event content is not `leave`.
|
||||
* The event sender is not a user ID on the origin server.
|
||||
* The `state_key` is not equal to the `sender`.
|
||||
|
||||
Servers MUST apply the validation above to the leave event.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../client-server/definitions/errors/error.yaml
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
"errcode": "M_INVALID_PARAM",
|
||||
"error": "Not a leave event."
|
||||
}
|
||||
servers:
|
||||
- url: "{protocol}://{hostname}{basePath}"
|
||||
variables:
|
||||
|
|
|
|||
|
|
@ -134,6 +134,27 @@ paths:
|
|||
examples:
|
||||
response:
|
||||
value: {}
|
||||
"400":
|
||||
description: |-
|
||||
The `M_INVALID_PARAM` error code is used to indicate one or more of the following:
|
||||
|
||||
* The leave event fails a [signature check](/server-server-api/#validating-hashes-and-signatures-on-received-events).
|
||||
* The event type is not `m.room.member`.
|
||||
* The `membership` field inside the event content is not `leave`.
|
||||
* The event sender is not a user ID on the origin server.
|
||||
* The `state_key` is not equal to the `sender`.
|
||||
|
||||
Servers MUST apply the validation above to the leave event.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../client-server/definitions/errors/error.yaml
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
"errcode": "M_INVALID_PARAM",
|
||||
"error": "Not a leave event."
|
||||
}
|
||||
servers:
|
||||
- url: "{protocol}://{hostname}{basePath}"
|
||||
variables:
|
||||
|
|
|
|||
30
data/schemas/oauth2-account-management-server-metadata.yaml
Normal file
30
data/schemas/oauth2-account-management-server-metadata.yaml
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# 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.
|
||||
type: object
|
||||
title: OAuth 2.0 Server Metadata Account Management Extension
|
||||
properties:
|
||||
account_management_uri:
|
||||
type: string
|
||||
format: uri
|
||||
description: |-
|
||||
The URL where the user is able to access the account management capabilities of the
|
||||
server.
|
||||
account_management_actions_supported:
|
||||
type: array
|
||||
description: |-
|
||||
List of [actions](/client-server-api/#account-management-url-actions) that the account
|
||||
management URL supports.
|
||||
items:
|
||||
type: string
|
||||
description: An action that the account management URL supports.
|
||||
29
data/schemas/oauth2-account-management-url.yaml
Normal file
29
data/schemas/oauth2-account-management-url.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.
|
||||
type: object
|
||||
title: OAuth 2.0 Account Management URL Query Parameters
|
||||
properties:
|
||||
action:
|
||||
type: string
|
||||
description: |-
|
||||
The action that the user wishes to take. Must match one of the actions advertised by the
|
||||
server in [`account_management_actions_supported`](/client-server-api/#account-management-url-discovery).
|
||||
device_id:
|
||||
type: string
|
||||
description: |-
|
||||
For Matrix-specific actions, the user's device ID. Actions which don't support the device ID
|
||||
will ignore 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.
|
||||
Loading…
Reference in a new issue