m.oauth_params.yaml

# Copyright 2025 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: m.oauth params
description: Schema for `m.oauth` entry in the `params` object in a User-Interactive Authentication response.
required: ['url']
properties:
  url:
    type: string
    format: uri
    description: |
      A URL pointing to the homeserver's OAuth account management web UI
      where the user can approve the action. MUST be a valid URI with scheme
      `http://` or `https://`, the latter being RECOMMENDED.
    pattern: "^https?://"
example: {
    "url": "https://example.org/account/reset-cross-signing"
}