MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
list=allusers (au)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0-or-later
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, sysop, interface-admin, bureaucrat, suppress, confirmed, upwizcampeditors, checkuser, widgeteditor, smwadministrator, smwcurator, smweditor
- auexcludegroup
Exclude users in the given groups.
- Values (separate with | or alternative): bot, sysop, interface-admin, bureaucrat, suppress, confirmed, upwizcampeditors, checkuser, widgeteditor, smwadministrator, smwcurator, smweditor
- 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, createpage, createtalk, delete, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjson, editmyuserjs, editmyuserjsredirect, editmywatchlist, editsemiprotected, editsitecss, editsitejson, editsitejs, editusercss, edituserjson, edituserjs, hideuser, import, importupload, ipblock-exempt, managechangetags, markbotedits, mergehistory, minoredit, move, movefile, move-categorypages, move-rootuserpages, move-subpages, nominornewtalk, noratelimit, override-export-depth, pagelang, patrol, patrolmarks, protect, purge, read, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, suppressionlog, suppressredirect, suppressrevision, unblockself, undelete, unwatchedpages, upload, upload_by_url, userrights, userrights-interwiki, viewmyprivateinfo, viewmywatchlist, viewsuppressed, writeapi, viewedittab, editrestrictedfields, createclass, multipageedit, replacetext, viewserverstatus, addpagetoanywatchlist, removepagefromanywatchlist, seepagewatchers, talk, adminlinks, batchuserrights, approverevisions, viewlinktolatest, viewapprover, upwizcampaigns, mass-upload, datatransferimport, ajaxpoll-vote, ajaxpoll-view-results, ajaxpoll-view-results-before-vote, override-antispoof, checkuser, checkuser-log, skipcaptcha, gadgets-edit, gadgets-definition-edit, nuke, renameuser, editwidgets, collectionsaveasuserpage, collectionsaveascommunitypage, generatepages, usermerge, webchat, 1, geocode, interwiki
- Maximum number of values is 50 (500 for bots).
- 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, groups, implicitgroups, rights, editcount, registration, centralids
- aulimit
How many total user names to return.
- No more than 500 (5,000 for bots) allowed.
- Type: integer or max
- 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.
Example:
- List users starting at Y.
- api.php?action=query&list=allusers&aufrom=Y [open in sandbox]