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

HS' can send 3PID token. Add a new submit_url field

Browse source
This commit is contained in:
Andrew Morgan 2019-06-07 10:58:43 +01:00
parent 9ac89cc915
commit 3148184052
2 changed files with 228 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -132,11 +132,30 @@ paths:
}
responses:
200:
description: The addition was successful.
description: |-
The addition was successful.
``submit_url`` is an optional field containing a URL where the
client must submit a validation token to, with identical parameters
to the Identity Service API's ``/validate/email/submitToken``
endpoint. The homeserver will send this token to the user, which
should then be prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's involvement.
examples:
application/json: {}
application/json: {
"submit_url": "https://example.org/path/to/submitToken"
}
schema:
type: object
properties:
submit_url:
type: string
description: |-
An optional URL to submit information to to verify a
third-party identifier.
example: "https://example.org/path/to/submitToken"
403:
description: The credentials could not be verified with the identity server.
examples:
@ -187,12 +206,14 @@ paths:
post:
summary: Begins the validation process for an email address for association with the user's account.
description: |-
Proxies the Identity Service API ``validate/email/requestToken``, but
first checks that the given email address is **not** already associated
with an account on this homeserver. This API should be used to request
validation tokens when adding an email address to an account. This API's
parameters and response are identical to that of the |/register/email/requestToken|_
endpoint.
The homeserver should check that the given email address is **not**
already associated with an account on this homeserver. This API should
be used to request validation tokens when adding an email address to an
account. This API's parameters and response are identical to that of
the |/register/email/requestToken|_ endpoint. The homeserver has the
choice of validating the email address itself, or proxying the request
to the ``validate/email/requestToken`` Identity Server API on the
server sent in ``id_server``.
operationId: requestTokenTo3PIDEmail
parameters:
- in: body
@ -212,9 +233,38 @@ paths:
required: ['id_server']
responses:
200:
description: An email was sent to the given address.
description: |-
An email was sent to the given address.
Note that this may be an email containing the validation token or
it may be informing the user of an error.
``submit_url`` is an optional field containing a URL where the
client must submit a validation token to, with identical parameters
to the Identity Service API's ``/validate/email/submitToken``
endpoint. The homeserver will send this token to the user, which
should then be prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's involvement.
schema:
$ref: "../identity/definitions/sid.yaml"
allOf:
- $ref: "../identity/definitions/sid.yaml"
- type: object
properties:
submit_url:
type: string
description: |-
An optional field containing a URL where the client
must submit a validation token to, with identical
parameters to the Identity Service API's
``/validate/email/submitToken`` endpoint. The homeserver
will send this token to the user, which should then be
prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's
involvement.
example: "https://example.org/path/to/submitToken"
403:
description: |-
The homeserver does not allow the third party identifier as a
@ -241,12 +291,14 @@ paths:
post:
summary: Begins the validation process for a phone number for association with the user's account.
description: |-
Proxies the Identity Service API ``validate/msisdn/requestToken``, but
first checks that the given phone number is **not** already associated
with an account on this homeserver. This API should be used to request
validation tokens when adding a phone number to an account. This API's
parameters and response are identical to that of the |/register/msisdn/requestToken|_
endpoint.
The homeserver should check that the given phone number is **not**
already associated with an account on this homeserver. This API should
be used to request validation tokens when adding a phone number to an
account. This API's parameters and response are identical to that of
the |/register/msisdn/requestToken|_ endpoint. The homeserver has the
choice of validating the phone number itself, or proxying the request
to the ``validate/msisdn/requestToken`` Identity Server API on the
server sent in ``id_server``.
operationId: requestTokenTo3PIDMSISDN
parameters:
- in: body
@ -266,9 +318,37 @@ paths:
required: ['id_server']
responses:
200:
description: An SMS message was sent to the given phone number.
description: |-
An SMS message was sent to the given phone number.
``submit_url`` is an optional field containing a URL where the
client must submit a validation token to, with identical parameters
to the Identity Service API's ``/validate/msisdn/submitToken``
endpoint. The homeserver will send this token to the user, which
should then be prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's involvement.
schema:
$ref: "../identity/definitions/sid.yaml"
allOf:
- $ref: "../identity/definitions/sid.yaml"
- type: object
properties:
submit_url:
type: string
description: |-
An optional field containing a URL where the client
must submit a validation token to, with identical
parameters to the Identity Service API's
``/validate/email/submitToken`` endpoint. The homeserver
will send this token to the user, which should then be
prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's
involvement.
example: "https://example.org/path/to/submitToken"
403:
description: |-
The homeserver does not allow the third party identifier as a

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

@ -204,10 +204,11 @@ paths:
post:
summary: Begins the validation process for an email to be used during registration.
description: |-
Proxies the Identity Service API ``validate/email/requestToken``, but
first checks that the given email address is not already associated
with an account on this homeserver. See the Identity Service API for
further information.
The homeserver should check that the given email address is **not**
already associated with an account on this homeserver. The homeserver
has the choice of validating the email address itself, or proxying the
request to the ``validate/email/requestToken`` Identity Server API on
the server sent in ``id_server``.
operationId: requestTokenToRegisterEmail
parameters:
- in: body
@ -231,8 +232,34 @@ paths:
An email has been sent to the specified address.
Note that this may be an email containing the validation token or it may be informing
the user of an error.
``submit_url`` is an optional field containing a URL where the
client must submit a validation token to, with identical parameters
to the Identity Service API's ``/validate/email/submitToken``
endpoint. The homeserver will send this token to the user, which
should then be prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's involvement.
schema:
$ref: "../identity/definitions/sid.yaml"
allOf:
- $ref: "../identity/definitions/sid.yaml"
- type: object
properties:
submit_url:
type: string
description: |-
An optional field containing a URL where the client
must submit a validation token to, with identical
parameters to the Identity Service API's
``/validate/email/submitToken`` endpoint. The homeserver
will send this token to the user, which should then be
prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's
involvement.
example: "https://example.org/path/to/submitToken"
403:
description: The homeserver does not permit the address to be bound.
schema:
@ -264,10 +291,11 @@ paths:
post:
summary: Requests a validation token be sent to the given phone number for the purpose of registering an account
description: |-
Proxies the Identity Service API ``validate/msisdn/requestToken``, but
first checks that the given phone number is not already associated
with an account on this homeserver. See the Identity Service API for
further information.
The homeserver should check that the given phone number is **not**
already associated with an account on this homeserver. The homeserver
has the choice of validating the phone number itself, or proxying the
request to the ``validate/msisdn/requestToken`` Identity Server API on
the server sent in ``id_server``.
operationId: requestTokenToRegisterMSISDN
parameters:
- in: body
@ -291,8 +319,34 @@ paths:
An SMS message has been sent to the specified phone number.
Note that this may be an SMS message containing the validation token or it may be informing
the user of an error.
``submit_url`` is an optional field containing a URL where the
client must submit a validation token to, with identical parameters
to the Identity Service API's ``/validate/msisdn/submitToken``
endpoint. The homeserver will send this token to the user, which
should then be prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's involvement.
schema:
$ref: "../identity/definitions/sid.yaml"
allOf:
- $ref: "../identity/definitions/sid.yaml"
- type: object
properties:
submit_url:
type: string
description: |-
An optional field containing a URL where the client
must submit a validation token to, with identical
parameters to the Identity Service API's
``/validate/email/submitToken`` endpoint. The homeserver
will send this token to the user, which should then be
prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's
involvement.
example: "https://example.org/path/to/submitToken"
403:
description: The homeserver does not permit the address to be bound.
schema:
@ -377,16 +431,21 @@ paths:
post:
summary: Requests a validation token be sent to the given email address for the purpose of resetting a user's password
description: |-
Proxies the Identity Service API ``validate/email/requestToken``, but
first checks that the given email address **is** associated with an account
on this homeserver. This API should be used to request
validation tokens when authenticating for the
`account/password` endpoint. This API's parameters and response are
identical to that of the HS API |/register/email/requestToken|_ except that
`M_THREEPID_NOT_FOUND` may be returned if no account matching the
given email address could be found. The server may instead send an
email to the given address prompting the user to create an account.
`M_THREEPID_IN_USE` may not be returned.
The homeserver should check that the given email address **is
associated** with an account on this homeserver. This API should be
used to request validation tokens when authenticating for the
``account/password`` endpoint.
This API's parameters and response are identical to that of the HS API
|/register/email/requestToken|_ except that ``M_THREEPID_NOT_FOUND``
may be returned if no account matching the given email address could be
found. The server may instead send an email to the given address
prompting the user to create an account. ``M_THREEPID_IN_USE`` may not
be returned.
The homeserver has the choice of validating the email address itself,
or proxying the request to the ``validate/email/requestToken`` Identity
server api on the server sent in ``id_server``.
.. |/register/email/requestToken| replace:: ``/register/email/requestToken``
@ -412,7 +471,24 @@ paths:
200:
description: An email was sent to the given address.
schema:
$ref: "../identity/definitions/sid.yaml"
allOf:
- $ref: "../identity/definitions/sid.yaml"
- type: object
properties:
submit_url:
type: string
description: |-
An optional field containing a URL where the client must
submit a validation token to, with identical parameters
to the Identity Service API's
``/validate/email/submitToken`` endpoint. The homeserver
will send this token to the user, which should then be
prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's
involvement.
example: "https://example.org/path/to/submitToken"
403:
description: |-
The homeserver does not allow the third party identifier as a
@ -439,16 +515,21 @@ paths:
post:
summary: Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.
description: |-
Proxies the Identity Service API ``validate/msisdn/requestToken``, but
first checks that the given phone number **is** associated with an account
on this homeserver. This API should be used to request
validation tokens when authenticating for the
`account/password` endpoint. This API's parameters and response are
identical to that of the HS API |/register/msisdn/requestToken|_ except that
`M_THREEPID_NOT_FOUND` may be returned if no account matching the
given phone number could be found. The server may instead send an
SMS message to the given address prompting the user to create an account.
`M_THREEPID_IN_USE` may not be returned.
The homeserver should check that the given phone number **is
associated** with an account on this homeserver. This API should be
used to request validation tokens when authenticating for the
``account/password`` endpoint.
This API's parameters and response are identical to that of the HS API
|/register/msisdn/requestToken|_ except that ``M_THREEPID_NOT_FOUND`` may
be returned if no account matching the given phone number could be
found. The server may instead send the SMS to the given phone number
prompting the user to create an account. ``M_THREEPID_IN_USE`` may not
be returned.
The homeserver has the choice of validating the phone number itself, or
proxying the request to the ``validate/msisdn/requestToken`` Identity
server api on the server sent in ``id_server``.
.. |/register/msisdn/requestToken| replace:: ``/register/msisdn/requestToken``
@ -474,7 +555,24 @@ paths:
200:
description: An SMS message was sent to the given phone number.
schema:
$ref: "../identity/definitions/sid.yaml"
allOf:
- $ref: "../identity/definitions/sid.yaml"
- type: object
properties:
submit_url:
type: string
description: |-
An optional field containing a URL where the client must
submit a validation token to, with identical parameters
to the Identity Service API's
``/validate/msisdn/submitToken`` endpoint. The homeserver
will send this token to the user, which should then be
prompted to provide it to the client.
If this field is not present, the client can assume that
verification will happen without the client's
involvement.
example: "https://example.org/path/to/submitToken"
403:
description: |-
The homeserver does not allow the third party identifier as a