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.
- 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.
- Values (separate with | or alternative): ES_editors, bot, bureaucrat, editor, interface-admin, review, reviewer, suppress, sysop, widgeteditor
- auexcludegroup
Exclude users in the given groups.
- Values (separate with | or alternative): ES_editors, bot, bureaucrat, editor, interface-admin, review, reviewer, suppress, sysop, widgeteditor
- 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, bluespiceabout-viewspecialpage, bluespiceconfigmanager-viewspecialpage, bookshelf-viewspecialpage, bookshelfbookmanager-viewspecialpage, bot, browsearchive, bs-privacy-admin, categorymanager-viewspecialpage, changetags, checklistmodify, cognitiveprocessdesigner-editbpmn, content-transfer, contentprovisioning-viewspecialpage, contentstabilization-admin, contentstabilization-oversight, contentstabilization-stabilize, createaccount, createclass, createpage, createtalk, dashboards-viewspecialpage-userdashboard, datatransferimport, delete, delete-redirect, deletechangetags, deletedhistory, deletedtext, deletelogentry, deleterevision, dpl_param_delete_rules, dpl_param_update_rules, edit, editcontentmodel, editinterface, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmyuserjson, editmyuserjsredirect, editmywatchlist, editor, editprotected, editrestrictedfields, editsemiprotected, editsitecss, editsitejs, editsitejson, editusercss, edituserjs, edituserjson, editwidgets, embed_pdf, expirearticle, expiry-delete, extendedsearch-search-externalfile, extendedsearch-search-repofile, extendedsearch-search-specialpage, extendedsearch-search-wikipage, extendedstatistics-viewspecialpage-aggregated, flexiskin-api, flexiskin-viewspecialpage, forms-create-form, forms-edit-form-definition, gadgets-definition-edit, gadgets-edit, groupmanager-viewspecialpage, hideuser, import, importupload, interwikilinks-viewspecialpage, invitesignup, ipblock-exempt, managechangetags, markbotedits, merge-articles, mergehistory, minoredit, move, move-categorypages, move-rootuserpages, move-subpages, movefile, multipageedit, mwoauthmanageconsumer, mwoauthmanagemygrants, mwoauthproposeconsumer, mwoauthsuppress, mwoauthupdateownconsumer, mwoauthviewprivate, mwoauthviewsuppressed, namespacemanager-viewspecialpage, nominornewtalk, noratelimit, nuke, oathauth-api-all, oathauth-disable-for-user, oathauth-enable, oathauth-verify-user, oathauth-view-log, override-export-depth, page-checkout-clear, pageaccess-viewspecialpage, pageassignable, pageassignments, pagelang, pagetemplatesadmin-viewspecialpage, patrol, patrolmarks, permissionmanager-viewspecialpage, protect, purge, rating-archive, rating-read, rating-viewspecialpage, rating-write, read, readconfirmationremind, readconfirmationviewconfirmations, remindereditall, renameuser, replacetext, reupload, reupload-own, reupload-shared, rollback, sendemail, siteadmin, smw-admin, smw-pageedit, smw-patternedit, smw-schemaedit, smw-vieweditpageinfo, smw-viewentityassociatedrevisionmismatch, smw-viewjobqueuewatchlist, social-blog, social-blog-comment, social-deleteothers, social-editothers, social-editothersprofile, social-microblog, social-microblog-comment, social-resolve, social-source, social-tagging, social-topics, social-topics-comment, socialprofile-viewspecialpage, statistic-viewspecialpage, suppressionlog, suppressredirect, suppressrevision, uemodulebookpdf-export, uemodulepdf-export, uemodulepdfrecursive-export, uemodulepdfsubpages-export, unblockself, undelete, unwatchedpages, upload, upload_by_url, usermanager-deleteuser, usermanager-viewspecialpage, usermerge, userrights, userrights-interwiki, viewedittab, viewmyprivateinfo, viewmywatchlist, viewreaders, viewrevisionreaders, viewsuppressed, wikiadmin, workflows-admin, workflows-execute, workflows-view, 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.
- List users starting at Y.
- api.php?action=query&list=allusers&aufrom=Y [open in sandbox]