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)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0-or-later
Enumerate all registered users.
Specific parameters:
Other general parameters are available.
- aufrom
The username to start enumerating from.
- auto
The username 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. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.
- Values (separate with | or alternative): abusefilter-admin, abusefilter-restricted, autopatrol, autoreview, blockedfromchat, bot, bureaucrat, chatmod, checkuser, confirmed, interface-admin, interwiki-admin, non-stewardsuppress, patroller, push-subscription-manager, reviewer, steward, suppress, sysadmin, sysop, translateadmin
- auexcludegroup
Exclude users in the given groups.
- Values (separate with | or alternative): abusefilter-admin, abusefilter-restricted, autopatrol, autoreview, blockedfromchat, bot, bureaucrat, chatmod, checkuser, confirmed, interface-admin, interwiki-admin, non-stewardsuppress, patroller, push-subscription-manager, reviewer, steward, suppress, sysadmin, sysop, translateadmin
- 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): abusefilter-bypass-blocked-external-domains, abusefilter-hidden-log, abusefilter-hide-log, abusefilter-log, abusefilter-log-detail, abusefilter-log-private, abusefilter-modify, abusefilter-modify-blocked-external-domains, abusefilter-modify-global, abusefilter-modify-restricted, abusefilter-privatedetails, abusefilter-privatedetails-log, abusefilter-revert, abusefilter-view, abusefilter-view-private, apihighlimits, applychangetags, autoconfirmed, autocreateaccount, autopatrol, autoreview, autoreviewrestore, badoath, bigdelete, block, blockemail, bot, browsearchive, changeemail, changetags, chat, checkuser, checkuser-log, checkuser-temporary-account, checkuser-temporary-account-log, checkuser-temporary-account-no-preference, confirmemail, createaccount, createpage, createtalk, delete, delete-redirect, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editprotected, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, handle-reports, hideuser, import, importupload, interwiki, ipblock-exempt, linkpurge, mailpassword, manage-all-push-subscriptions, managechangetags, markbotedits, massmessage, mergehistory, minoredit, modchat, move, move-categorypages, move-rootuserpages, move-subpages, movefile, movestable, mwoauthmanageconsumer, mwoauthmanagemygrants, mwoauthproposeconsumer, mwoauthsuppress, mwoauthupdateownconsumer, mwoauthviewprivate, mwoauthviewsuppressed, newsletter, newsletter-announce, newsletter-create, newsletter-delete, newsletter-manage, newsletter-restore, noanalytics, nominornewtalk, noratelimit, nuke, oathauth-api-all, oathauth-disable-for-user, oathauth-enable, oathauth-verify-user, oathauth-view-log, override-antispoof, override-export-depth, pagelang, pagetranslation, patrol, patrolmarks, protect, purge, read, renameuser, renderfile, renderfile-nonstandard, replacetext, report, reupload, reupload-own, reupload-shared, review, rollback, sboverride, sendemail, sfsblock-bypass, siteadmin, skipcaptcha, spamblacklistlog, stablesettings, stashbasehtml, stashedit, suppressionlog, suppressredirect, suppressrevision, tboverride, tboverride-account, thanks-notification, themedesigner, titleblacklistlog, torunblocked, translate, translate-groupreview, translate-import, translate-manage, translate-messagereview, unblockable, unblockself, undelete, unreviewedpages, unwatchedpages, upload, upload_by_url, usermerge, userrights, userrights-interwiki, validate, viewmyprivateinfo, viewmywatchlist, viewpmlog, viewsuppressed, writeapi
- Maximum number of values is 50 (500 for clients that are 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 usernames 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.
Example:
- List users starting at Y.
- api.php?action=query&list=allusers&aufrom=Y [open in sandbox]