Spec Additional Error Codes for submitToken endpoint

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2025-12-19 11:19:42 +01:00
parent 6b5ff04d00
commit 064e8f1411
No known key found for this signature in database
GPG key ID: F26F4BE20A08255B
3 changed files with 50 additions and 6 deletions

View file

@ -24,16 +24,22 @@ properties:
submit_url:
type: string
format: uri
x-changedInMatrixVersion:
"1.18": |-
The URL has the same request and response parameters and error codes as
the Identity Service API's endpoint.
description: |-
An optional field containing a URL where the client must submit the
validation token to, with identical parameters to the Identity Service
API's `POST /validate/email/submitToken` endpoint (without the requirement
for an access token). The homeserver must send this token to the user (if
applicable), who should then be prompted to provide it to the client.
validation token, with identical request and response parameters and error
codes to the Identity Service API's
[`POST /_matrix/identity/v2/validate/email/submitToken`](/identity-service-api/#post_matrixidentityv2validateemailsubmittoken)
endpoint (without the requirement for an access token). The homeserver
must send this token to the user (if applicable), who 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 provided the homeserver
advertises this specification version in the `/versions` response
(ie: r0.5.0).
advertises this specification version in the [`GET /versions`](/client-server-api/#get_matrixclientversions)
response (ie: r0.5.0).
example: "https://example.org/path/to/submitToken"
required: ['sid']

View file

@ -153,6 +153,25 @@ paths:
value: {
"success": true
}
"400":
x-addedInMatrixVersion: "1.18"
description: |
An error occurred. Some possible errors are:
- `M_TOKEN_INCORRECT`: The token that the user entered to validate the session is
incorrect.
- `M_INVALID_PARAM`: One of the supplied parameters is not valid.
- `M_SESSION_EXPIRED`: The validation session in question has expired.
content:
application/json:
schema:
$ref: ../client-server/definitions/errors/error.yaml
examples:
response:
value: {
"errcode": "M_TOKEN_INCORRECT",
"error": "The token is incorrect"
}
"403":
description: |
The user must do something in order to use this endpoint. One example

View file

@ -155,6 +155,25 @@ paths:
value: {
"success": true
}
"400":
x-addedInMatrixVersion: "1.18"
description: |
An error occurred. Some possible errors are:
- `M_TOKEN_INCORRECT`: The token that the user entered to validate the session is
incorrect.
- `M_INVALID_PARAM`: One of the supplied parameters is not valid.
- `M_SESSION_EXPIRED`: The validation session in question has expired.
content:
application/json:
schema:
$ref: ../client-server/definitions/errors/error.yaml
examples:
response:
value: {
"errcode": "M_TOKEN_INCORRECT",
"error": "The token is incorrect"
}
"403":
description: |
The user must do something in order to use this endpoint. One example