diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index b4b630a8..67d12553 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -2283,16 +2283,9 @@ extended to include the following **optional** fields. ##### Account management URL parameters -The account management URL MAY accept the following query parameters: +The account management URL MAY accept the following minimum 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. +{{% definition path="schemas/oauth2-account-management-url" %}} ##### Account management URL actions diff --git a/data/schemas/oauth2-account-management-url.yaml b/data/schemas/oauth2-account-management-url.yaml new file mode 100644 index 00000000..aef3b6d5 --- /dev/null +++ b/data/schemas/oauth2-account-management-url.yaml @@ -0,0 +1,16 @@ +type: object +title: OAuth 2.0 Account Management URL Query Parameters +properties: + action: + $ref: ./oauth2-account-management-action.yaml + 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.