Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-20 16:38:37 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Deprecate id_server and make it optional

Browse source 
As per [MSC2263](https://github.com/matrix-org/matrix-doc/pull/2263)
This commit is contained in:
Travis Ralston 2019-10-03 09:41:45 -06:00
parent 1a8fbfedc9
commit 48b8a95df6
5 changed files with 28 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
api/client-server/administrative_contact.yaml
View file

@ -343,7 +343,9 @@ paths:
400: 400:
description: |- description: |-
The third party identifier is already in use on the homeserver, or The third party identifier is already in use on the homeserver, or
the request was invalid. the request was invalid. The error code ``M_SERVER_NOT_TRUSTED``
can be returned if the server does not trust/support the identity server
provided in the request.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
@ -391,7 +393,9 @@ paths:
400: 400:
description: |- description: |-
The third party identifier is already in use on the homeserver, or The third party identifier is already in use on the homeserver, or
the request was invalid. the request was invalid. The error code ``M_SERVER_NOT_TRUSTED``
can be returned if the server does not trust/support the identity server
provided in the request.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:

6
api/client-server/definitions/request_email_validation.yaml
View file

@ -22,6 +22,9 @@ allOf:
The hostname of the identity server to communicate with. May optionally The hostname of the identity server to communicate with. May optionally
include a port. This parameter is ignored when the homeserver handles include a port. This parameter is ignored when the homeserver handles
3PID verification. 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" example: "id.example.com"
id_access_token: id_access_token:
type: string type: string
@ -29,4 +32,5 @@ allOf:
An access token previously registered with the identity server. Servers An access token previously registered with the identity server. Servers
can treat this as optional to distinguish between r0.5-compatible clients can treat this as optional to distinguish between r0.5-compatible clients
and this specification version. and this specification version.
required: ["id_server", "id_access_token"]
Required if an ``id_server`` is supplied.

6
api/client-server/definitions/request_msisdn_validation.yaml
View file

@ -22,6 +22,9 @@ allOf:
The hostname of the identity server to communicate with. May optionally The hostname of the identity server to communicate with. May optionally
include a port. This parameter is ignored when the homeserver handles include a port. This parameter is ignored when the homeserver handles
3PID verification. 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" example: "id.example.com"
id_access_token: id_access_token:
type: string type: string
@ -29,4 +32,5 @@ allOf:
An access token previously registered with the identity server. Servers An access token previously registered with the identity server. Servers
can treat this as optional to distinguish between r0.5-compatible clients can treat this as optional to distinguish between r0.5-compatible clients
and this specification version. and this specification version.
required: ["id_server", "id_access_token"]
Required if an ``id_server`` is supplied.

8
api/client-server/registration.yaml
View file

@ -425,7 +425,9 @@ paths:
400: 400:
description: |- description: |-
The referenced third party identifier is not recognised by the The referenced third party identifier is not recognised by the
homeserver, or the request was invalid homeserver, or the request was invalid. The error code ``M_SERVER_NOT_TRUSTED``
can be returned if the server does not trust/support the identity server
provided in the request.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:
@ -485,7 +487,9 @@ paths:
400: 400:
description: |- description: |-
The referenced third party identifier is not recognised by the The referenced third party identifier is not recognised by the
homeserver, or the request was invalid homeserver, or the request was invalid. The error code ``M_SERVER_NOT_TRUSTED``
can be returned if the server does not trust/support the identity server
provided in the request.
schema: schema:
$ref: "definitions/errors/error.yaml" $ref: "definitions/errors/error.yaml"
examples: examples:

6
specification/client_server_api.rst
View file

@ -809,6 +809,9 @@ To use this authentication type, clients should submit an auth dict as follows:
"session": "<session ID>" "session": "<session ID>"
} }
Note that ``id_server`` (and therefore ``id_access_token``) is optional if the
``/requestToken`` request did not include them.
Phone number/MSISDN-based (identity / homeserver) Phone number/MSISDN-based (identity / homeserver)
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
:Type: :Type:
@ -838,6 +841,9 @@ To use this authentication type, clients should submit an auth dict as follows:
"session": "<session ID>" "session": "<session ID>"
} }
Note that ``id_server`` (and therefore ``id_access_token``) is optional if the
``/requestToken`` request did not include them.
Dummy Auth Dummy Auth
<<<<<<<<<< <<<<<<<<<<
:Type: :Type: