wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add M_USER_DEACTIVATED to list of error codes (#2234)

Browse source 
Spec PR for [MSC 2181](https://github.com/matrix-org/matrix-doc/pull/2181).

Adds the `M_USER_DEACTIVATED` error code and a short description to the client-server API.
This commit is contained in:
Andrew Morgan 2019-08-15 18:10:38 +01:00 • committed by GitHub
parent 87590cd778
commit 92c6f4c38e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
api/client-server/login.yaml
View file

@ -194,10 +194,13 @@ paths:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
403: 403:
description: |- description: |-
The login attempt failed. For example, the password may have been incorrect. The login attempt failed. This can include one of the following error codes:
* ``M_FORBIDDEN``: The provided authentication data was incorrect.
* ``M_USER_DEACTIVATED``: The user has been deactivated.
examples: examples:
application/json: { application/json: {
"errcode": "M_FORBIDDEN"} "errcode": "M_FORBIDDEN"
}
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429: 429:

1
changelogs/client_server/newsfragments/2234.feature Normal file
View file

@ -0,0 +1 @@
Add ``M_USER_DEACTIVATED`` error code.

4
specification/client_server_api.rst
View file

@ -150,6 +150,10 @@ Other error codes the client might encounter are:
:``M_UNAUTHORIZED``: :``M_UNAUTHORIZED``:
The request was not correctly authorized. Usually due to login failures. The request was not correctly authorized. Usually due to login failures.
:``M_USER_DEACTIVATED``:
The user ID associated with the request has been deactivated. Typically for
endpoints that prove authentication, such as ``/login``.
:``M_USER_IN_USE``: :``M_USER_IN_USE``:
Encountered when trying to register a user ID which has been taken. Encountered when trying to register a user ID which has been taken.