matrix-spec-proposals/api/client-server/definitions/request_email_validation.yaml

# Copyright 2019 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
allOf:
- $ref: "../../identity/definitions/request_email_validation.yaml"
- type: object
  properties:
    id_server:
      type: string
      description: |-
        The hostname of the identity server to communicate with. May optionally
        include a port. This parameter is ignored when the homeserver handles
        3PID verification.

        This parameter is deprected with a plan to be removed in a future specification
        version for ``/account/password`` and ``/register`` requests.        
      example: "id.example.com"
    id_access_token:
      type: string
      description: |-
        An access token previously registered with the identity server. Servers
        can treat this as optional to distinguish between r0.5-compatible clients
        and this specification version.

        Required if an ``id_server`` is supplied.