Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add M_USER_DEACTIVATED to list of error codes #2234

Merged
merged 10 commits into from
Aug 15, 2019
7 changes: 5 additions & 2 deletions api/client-server/login.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -194,10 +194,13 @@ paths:
"$ref": "definitions/errors/error.yaml"
403:
description: |-
The login attempt failed. For example, the password may have been incorrect.
The login attempt failed. This may include one of the following error codes:
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
* ``M_FORBIDDEN``: The provided authentication data was incorrect.
* ``M_USER_DEACTIVATED``: The user has been deactivated.
examples:
application/json: {
"errcode": "M_FORBIDDEN"}
"errcode": "M_FORBIDDEN"
}
schema:
"$ref": "definitions/errors/error.yaml"
429:
Expand Down
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2234.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add ``M_USER_DEACTIVATED`` error code.
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 4 additions & 0 deletions specification/client_server_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@ Other error codes the client might encounter are:
:``M_UNAUTHORIZED``:
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`.
anoadragon453 marked this conversation as resolved.
Show resolved Hide resolved

:``M_USER_IN_USE``:
Encountered when trying to register a user ID which has been taken.

Expand Down