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=globalallusers (agu)
- This module requires read rights.
- Source: AntiSpoof for CentralAuth
- License: GPL-2.0-or-later
Enumerate all global users.
Parameters:
- agufrom
The user name to start enumerating from.
- aguto
The user name to stop enumerating at.
- aguprefix
Search for all users that begin with this value.
- agudir
Direction to sort in.
- One of the following values: ascending, descending
- Default: ascending
- agugroup
Limit users to given global groups.
- Values (separate with | or alternative): steward
- aguexcludegroup
Exclude users in given global groups.
- Values (separate with | or alternative): steward
- aguprop
What pieces of information to include:
- lockinfo
- Whether the user account is locked.
- groups
- Lists global groups that the user is in. This uses more server resources and may return fewer results than the limit.
- existslocally
- Adds the information if the user exists locally.
- Values (separate with | or alternative): existslocally, groups, lockinfo
- agulimit
How many total user names to return.
- Type: integer or max
- The value must be between 1 and 500.
- Default: 10
Examples:
- List global users
- api.php?action=query&list=globalallusers [open in sandbox]
- Show some information for global users starting from "ABC"
- api.php?action=query&list=globalallusers&agufrom=ABC&aguprop=lockinfo|groups|existslocally [open in sandbox]