API:Login

The MediaWiki API may require your application or client to provide authenticated user credentials to the API in order to complete an operation successfully.

As of MediaWiki 1.27, there are two API actions used to authenticate:  and.

Bots and other non-interactive applications should generally use oauthowneronly>Special:MyLanguage/OAuth/Owner-only consumers|owner-only OAuth consumers when available to authenticate as it is more secure, however botpasswords>Special:MyLanguage/Manual:Bot passwords|bot passwords can be used with the  action as described on this page.

Interactive applications such as custom editors or patrolling applications that provide a service without intending to fully replace the website should generally also use oauthfordevelopers>Special:MyLanguage/OAuth/For Developers|OAuth for authenticating the tool, as it is easier and more secure, however the  action can be used if that is unavailable.

Interactive applications such as mobile apps that aim to completely replace access to the web-based user interface should use the  action to authenticate.

Whether to log in
Your client will need to log in to MediaWiki if:


 * it needs to obtain information or carry out an action that is restricted to users with certain rights


 * it is making large queries that would be inefficient without the higher per-request limits reserved for accounts with certain rights

On wikis that allow anonymous editing, it's possible to edit through the API without logging in, but it's highly recommended that you do log in.

On private wikis, logging in is required to use any API functionality.

If your client is written in JavaScript running in the user's browser, it will usually act with the credentials of the user who's running it and so will not need to log in itself.

In this case, you won't need to login using the web service API--you'll just need to ensure that the user has logged in through the web interface.

If your client is using OAuth or a similar mechanism, it will not need to explicitly log in as all OAuth requests are already authenticated.

Application-specific user accounts
Rather than having your application log in as yourself, you may want to create a separate user account just for your application.

This is especially important if your application:


 * is carrying out automated editing or some other bulk operation.


 * invokes large or performance-intensive queries.

With a separate account, the changes made by your application can be easily tracked, and special rights (usually a "bot" user group) can be applied to the application's account.

Some wikis have a policy related to automated editing, and/or a procedure for dealing with "bot" user group requests.

How to check if you're logged in
The login mechanism typically uses cookies to track the logged-in status of a session.

Clients should check directly if they are logged in, rather than attempting to determine the status by examining the cookies or by blindly logging in whether or not it is required.

The recommended way to ensure that requests are logged in is to use the assert=user parameter accepted on all API calls.

When this parameter is provided and the user is not logged in, an assertuserfailed error will be returned.

To directly check which user (if any) you are currently logged in as, use the  query module.

How to log in
In MediaWiki versions before 1.27, only the  action is available and should be used by all clients needing to login.

As of 1.27, the  action should only be used in combination with botpasswords>Special:MyLanguage/Manual:Bot passwords|bot passwords, and   should be used by interactive applications.

Note that logging in and remaining logged in requires correct HTTP cookie handling by your client on all requests (including getting and using the login token).

Typically your framework or HTTP request library will handle this for you.

The   action
To successfully log in, a login token must first be retrieved.

In MediaWiki 1.27 and later, this token should be fetched using a  query:  .

For older versions, a POST to the  action is required instead.

Other fields might be included in the response, however these are deprecated and should be ignored if present.

Once the token has been fetched, the login may proceed.

Other fields might be included in the response, however these are deprecated and should be ignored if present.

The result field in the output indicates whether the login was successful.

Non-successful results include:


 * NeedToken if the lgtoken parameter was not provided or no session was active (e.g. your cookie handling is broken).
 * WrongToken if the supplied token was not a valid token.
 * Failed (since 1.27) if the login failed. A reason field will exist in the response containing and explanation of the failure.
 * Aborted (since 1.27) if the login using the main account password (rather than a bot password) cannot proceed because user interaction is required. The  action should be used instead.
 * NoName (before 1.27) if no lgname was provided.
 * Illegal (before 1.27) if the lgname is not a valid user name.
 * NotExists (before 1.27) if supplied user does not exist.
 * EmptyPass (before 1.27) if the supplied password is empty.
 * WrongPass or WrongPluginPass (before 1.27) if the password is incorrect.
 * CreateBlocked (before 1.27) if auto-creation of the account is required but is not possible.
 * Throttled (before 1.27) if login attempts from your IP have been throttled.
 * Blocked (before 1.27) if the user being logged in to is blocked and blocks prevent login on the wiki.
 * Aborted (before 1.27) if the login was aborted by an extension without further detail. A reason field may be present.

The   action
This action implements an interactive login process, which might include CAPTCHAs, interactions with third-party authentication services, two-factor authentication, and more.

As such, the specific fields required may vary depending on the configuration of the wiki.

A description of the fields needed should be fetched from the  query.

On a wiki without any special authentication extensions, the fields needed might include username, password , and optionally rememberMe , so the login request would look something like this:

On the other hand, a wiki with a CAPTCHA extension, an extension for authentication using OpenID Connect, and a two-factor authentication extension might have a more complicated authentication process.

The client would be expected to redirect the user's browser to the provided redirecttarget.

The OpenID provider would authenticate, and redirect to Special:OpenIDConnectReturn on the wiki, which would validate the OpenID response and then redirect to the loginreturnurl provided in the first POST to the API with the code and state parameters added.

The client gets control of the process back at this point and makes its next API request.

Now the client needs to ask the user to check their two-factor authentication app for the current code, and submit that back to the server to continue the authentication process.

The authentication process has finally succeeded.

If at any point authentication fails, a response with status FAIL will be returned, along with a message to display to the user.

In certain cases it's possible to receive a RESTART response, for example if the OpenID Connect extension had no mapping for the OpenID account to any local user.

In this case the client might restart the login process from the beginning or might switch to account creation, in either case passing the loginpreservestate or createpreservestate parameter to preserve some state.