API:Assert

From MediaWiki.org
Jump to: navigation, search

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎français • ‎magyar • ‎Հայերեն • ‎italiano • ‎日本語 • ‎Bahasa Melayu • ‎Nederlands • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎sicilianu • ‎中文
Tools clipart.png This page is part of the MediaWiki action API documentation.

MediaWiki action API

v · d · e
MediaWiki version: 1.23

To make sure your bot doesn't edit while logged out, the action API provides an assert parameter which you can add to any request.

  • assert=user: Checks that your account is logged in
  • assert=bot: Checks that your account has the "bot" user right

If the assertion fails, error codes of assertuserfailed or assertbotfailed will be returned.

Checking if you are logged in[edit]

If you simply want to check whether you are logged into the action API, you can issue a request with parameters action=query&assert=user. This will return a simple blank response ({} in the JSON format) if you are indeed logged in, or the assertuserfailed error if not.

Normally, you will not need to do this. Instead, add the assert=user parameter to all requests that should be made by a logged-in user.