MediaWiki API help
This is an auto-generated MediaWiki Action API documentation page.
list=globalusers (gus)
- This module requires read rights.
- Source: CentralAuth
- License: GPL-2.0-or-later
Get information about a list of global users.
Specific parameters:
Other general parameters are available.
- gusprop
Which pieces of information to include:
- locked
- Adds information on whether the user is globally locked.
- editcount
- Adds the user's global edit count.
- registration
- Adds the user's global account registration timestamp.
- localinfo
- Adds the user's local account information.
- groups
- Lists all the global groups each user belongs to.
- groupmemberships
- Lists global groups that each user has been explicitly assigned to, including the expiry date of each group membership.
- rights
- Lists all the global rights each user has.
- Values (separate with | or alternative): editcount, groupmemberships, groups, localinfo, locked, registration, rights
- gususers
A list of global users to obtain information for. Cannot be used together with guscentralids.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- guscentralids
A list of central user IDs to obtain information for. Cannot be used together with gususers.
- Type: list of integers
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- guslocalgroups
When listing groups or rights, only include those that apply to the current wiki.
- Type: boolean (details)
Examples:
- Return information for the user Example.
- api.php?action=query&list=globalusers&gususers=Example [open in sandbox]
- Return information for the user with central ID 1.
- api.php?action=query&list=globalusers&guscentralids=1 [open in sandbox]