MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

list=allusers (au)

(main | query | allusers)

Enumerate all registered users.

Parameters:
aufrom

The user name to start enumerating from.

auto

The user name to stop enumerating at.

auprefix

Search for all users that begin with this value.

audir

Direction to sort in.

One of the following values: ascending, descending
Default: ascending
augroup

Only include users in the given groups.

Values (separate with | or alternative): bot, bureaucrat, interface-admin, suppress, sysop, widgeteditor, wiki-editors, wiki-sysops
auexcludegroup

Exclude users in the given groups.

Values (separate with | or alternative): bot, bureaucrat, interface-admin, suppress, sysop, widgeteditor, wiki-editors, wiki-sysops
aurights

Only include users with the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.

Values (separate with | or alternative): apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createclass, createpage, createtalk, delete, delete-redirect, deletecargodata, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editrestrictedfields, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, editwidgets, gadgets-definition-edit, gadgets-edit, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, multipageedit, nominornewtalk, noratelimit, override-export-depth, pagelang, pagetranslation, patrol, patrolmarks, protect, purge, read, recreatecargodata, reupload, reupload-own, reupload-shared, rollback, runcargoqueries, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, translate, translate-groupreview, translate-import, translate-manage, translate-messagereview, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewedittab, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi
Maximum number of values is 50 (500 for clients allowed higher limits).
auprop

Which pieces of information to include:

blockinfo
Adds the information about a current block on the user.
groups
Lists groups that the user is in. This uses more server resources and may return fewer results than the limit.
implicitgroups
Lists all the groups the user is automatically in.
rights
Lists rights that the user has.
editcount
Adds the edit count of the user.
registration
Adds the timestamp of when the user registered if available (may be blank).
centralids
Adds the central IDs and attachment status for the user.
Values (separate with | or alternative): blockinfo, centralids, editcount, groups, implicitgroups, registration, rights
aulimit

How many total user names to return.

Type: integer or max
The value must be between 1 and 500.
Default: 10
auwitheditsonly

Only list users who have made edits.

Type: boolean (details)
auactiveusers

Only list users active in the last 30 days.

Type: boolean (details)
auattachedwiki

With auprop=centralids, also indicate whether the user is attached with the wiki identified by this ID.