Authentication

The MediaWiki Action API supports several authentication methods. For automated scripts and bots, bot passwords are the recommended approach. Interactive applications can use the clientlogin flow backed by AuthManager. Both approaches ultimately produce a session cookie that must be included with subsequent requests.

Authentication methods

Bot passwords

Purpose-built credentials for API bots. Scoped to specific permissions. Created at Special:BotPasswords. Use with action=login.

OAuth

Industry-standard delegated authorization. Suitable for third-party applications acting on behalf of users. Requires the OAuth extension.

clientlogin

Interactive multi-step login via AuthManager. Supports MFA, CAPTCHA, and external identity providers. Use for user-facing applications.

CSRF tokens

Not an authentication method itself, but required for all write operations. Obtained after authenticating via action=query&meta=tokens.

Bot passwords (recommended for bots)

Bot passwords are separate credentials tied to a main account. They support fine-grained permission scopes (e.g., allow only editing, not blocking users) and do not expose your main account password.

Creating a bot password

Navigate to Special:BotPasswords

Go to https://YOUR_WIKI/wiki/Special:BotPasswords while logged in to your main account.

Enter a bot name

Choose a descriptive name for the bot application (e.g., my-archiving-bot). This becomes part of the login username: MainAccountName@BotName.

Select permission grants

Check only the permissions your bot actually needs. Available grants include: edit existing pages, create new pages, upload files, delete pages, patrol changes, send email, and others.

Save and record the password

The generated password is shown only once. Store it securely. The full login username format is MainAccountName@BotName.

Logging in with a bot password

Bot password authentication uses action=login in a two-step process:

Make an initial request without a token to obtain a login token.
Submit credentials with the token.

action=login requires POST for both steps. The password and token parameters must be posted (enforced via requirePostedParameters in ApiLogin::execute).

# Step 1: Get a login token
curl -c cookies.txt -X POST \
  "https://en.wikipedia.org/w/api.php" \
  --data "action=query&meta=tokens&type=login&format=json&formatversion=2"

# Response: { "query": { "tokens": { "logintoken": "abc123+\\" } } }

# Step 2: Log in with the token
curl -b cookies.txt -c cookies.txt -X POST \
  "https://en.wikipedia.org/w/api.php" \
  --data-urlencode "action=login" \
  --data-urlencode "lgname=MyAccount@my-bot" \
  --data-urlencode "lgpassword=GENERATED_BOT_PASSWORD" \
  --data-urlencode "lgtoken=abc123+\\" \
  --data "format=json&formatversion=2"

{
  "login": {
    "result": "Success",
    "lguserid": 12345,
    "lgusername": "MyAccount@my-bot"
  }
}

The outcome of the login attempt. Possible values: Success, Failed, NeedToken, WrongToken, Aborted.

The user ID of the authenticated account. Only present on Success.

The username of the authenticated account. Only present on Success.

Human-readable failure reason. Only present on Failed or Aborted.

lgname

string

Username. For bot passwords, use the format MainAccountName@BotName.

lgpassword

string

Password (marked sensitive; must be POSTed).

lgtoken

string

lgdomain

string

Authentication domain, for wikis using external authentication systems (LDAP, etc.).

Using action=login with main account credentials (not a bot password) is deprecated and triggers a deprecation warning in the response. Main account logins via this endpoint require $wgEnableBotPasswords = false and are not recommended. Always create a dedicated bot password.

clientlogin (interactive/AuthManager flow)

action=clientlogin implements the full AuthManager login protocol, which supports multi-factor authentication, CAPTCHAs, and external identity providers. It is implemented in ApiClientLogin and is the correct choice for user-facing applications. clientlogin is a multi-step flow; the server may return UI or REDIRECT responses requesting additional data (e.g., a TOTP code or OAuth redirect).

# Step 1: Begin login
curl -c cookies.txt -X POST "https://en.wikipedia.org/w/api.php" \
  --data-urlencode "action=clientlogin" \
  --data-urlencode "loginreturnurl=https://your-app.example/callback" \
  --data-urlencode "logintoken=LOGIN_TOKEN" \
  --data-urlencode "username=ExampleUser" \
  --data-urlencode "password=USERPASSWORD" \
  --data "format=json&formatversion=2"

The returnurl parameter is required for redirect-based flows (e.g., OpenID Connect). For simple password-only logins it can be set to any valid URL. On success:

{ "clientlogin": { "status": "PASS", "username": "ExampleUser" } }

On MFA challenge:

{
  "clientlogin": {
    "status": "UI",
    "message": "Enter your two-factor authentication code.",
    "requests": [ ... ]
  }
}

Continue with continue=1 and the fields requested in requests.

CSRF tokens

Every write operation (edit, delete, move, protect, block, etc.) requires a CSRF token. The token is tied to the authenticated session and changes if the session is lost or the user logs out.

Fetching a CSRF token

curl -b cookies.txt \
  "https://en.wikipedia.org/w/api.php?action=query&meta=tokens&type=csrf&format=json&formatversion=2"

{
  "query": {
    "tokens": {
      "csrftoken": "d41d8cd98f00b204e9800998ecf8427e+\\"
    }
  }
}

The token always ends with +\. For anonymous users (or users without a valid session), the token value is +\ (a LoggedOutEditToken) and will be rejected by write operations.

Available token types

From ApiQueryTokens::getTokenTypeSalts, these token types are built in:

Type	Used by
`csrf`	edit, delete, move, protect, block, upload, and all other write actions
`watch`	action=watch
`patrol`	action=patrol
`rollback`	action=rollback
`userrights`	action=userrights
`login`	action=login (step 2)
`createaccount`	action=createaccount

Fetch multiple types in one request:

curl -b cookies.txt \
  "https://en.wikipedia.org/w/api.php?action=query&meta=tokens&type=csrf|watch|patrol&format=json&formatversion=2"

Fetch the CSRF token once per session and reuse it. Tokens are valid for the lifetime of the session. Do not request a new token for every write operation — this adds unnecessary latency and load.

Session handling

The API uses HTTP cookies for session state. When using requests in Python, the Session object handles cookie persistence automatically. When using curl, use -b cookies.txt -c cookies.txt for every request in the same session.

import requests

# A single Session object persists cookies across all requests
S = requests.Session()

# All requests through S share the same cookies / session
S.get("https://en.wikipedia.org/w/api.php", params={"action": "query", ...})
S.post("https://en.wikipedia.org/w/api.php", data={"action": "edit", ...})

OAuth

For third-party applications acting on behalf of users, OAuth is the appropriate choice. The MediaWiki OAuth extension implements OAuth 1.0a and OAuth 2.0. OAuth requires registering a consumer application at Special:OAuthConsumerRegistration. Once approved, users can authorize your application through the standard OAuth redirect flow, and your application receives an access token for that user. With OAuth, you do not use action=login. Instead, sign each API request with your OAuth credentials using an OAuth library.

from requests_oauthlib import OAuth1
import requests

auth = OAuth1(
    client_key="YOUR_CONSUMER_KEY",
    client_secret="YOUR_CONSUMER_SECRET",
    resource_owner_key="ACCESS_TOKEN",
    resource_owner_secret="ACCESS_TOKEN_SECRET",
)

response = requests.get(
    "https://en.wikipedia.org/w/api.php",
    params={"action": "query", "meta": "userinfo", "format": "json"},
    auth=auth,
)
print(response.json())

CSRF tokens are still required for write operations when using OAuth. Fetch them the same way — action=query&meta=tokens&type=csrf — with the OAuth-signed request.

Logout

End the current session with action=logout. This invalidates the session cookie and the CSRF token.

curl -b cookies.txt -c cookies.txt -X POST \
  "https://en.wikipedia.org/w/api.php" \
  --data-urlencode "action=logout" \
  --data-urlencode "token=$CSRF_TOKEN" \
  --data "format=json&formatversion=2"

{ "logout": {} }

action=logout requires a CSRF token (not a login token). Fetch it before logging out if you have not already done so.

Common authentication errors

Error code	Cause
`Failed`	Wrong username or password
`NeedToken`	Login token was missing from the request
`WrongToken`	Login token did not match the session
`Aborted`	Login was aborted, typically because the wiki requires bot passwords and a main account login was attempted
`badtoken`	CSRF token is invalid, stale, or belongs to a different session
`sessionlost`	The session expired between requests
`notloggedin`	A write operation was attempted without a valid session

REST API

Action API

PHP Services

Authentication methods

Bot passwords

OAuth

clientlogin

CSRF tokens

Bot passwords (recommended for bots)

Creating a bot password

Logging in with a bot password

clientlogin (interactive/AuthManager flow)

CSRF tokens

Fetching a CSRF token

Available token types

Session handling

OAuth

Logout

Common authentication errors

Build docs developers (and LLMs) love

REST API

Action API

PHP Services

Documentation Index

​Authentication methods

Bot passwords

OAuth

clientlogin

CSRF tokens

​Bot passwords (recommended for bots)

​Creating a bot password

​Logging in with a bot password

​Login response

​action=login parameters

​clientlogin (interactive/AuthManager flow)

​CSRF tokens

​Fetching a CSRF token

​Available token types

​Session handling

​OAuth

​Logout

​Common authentication errors

Build docs developers (and LLMs) love

Authentication methods

Bot passwords (recommended for bots)

Creating a bot password

Logging in with a bot password

Login response

action=login parameters

clientlogin (interactive/AuthManager flow)

CSRF tokens

Fetching a CSRF token

Available token types

Session handling

OAuth

Logout

Common authentication errors