API:Users

From MediaWiki.org
Jump to: navigation, search
This page is part of the MediaWiki action API documentation.

MediaWiki action API

v · d · e

Get information about a list of users. This module cannot be used as a generator. This module is implemented by ApiQueryUsers.php.

Parameters[edit]

  • ususers: A list of user names to get information for
  • ustoken: Which tokens to get 1.16+ (Deprecated in 1.24)
  • usprop: Which properties to get (Default: none)
    • blockinfo: Whether the user is blocked, by whom and why
    • groups: All groups the user belongs to
    • implicitgroups: All groups a user is automatically a member of 1.18+
    • rights: All rights the user has 1.17+
    • editcount: The number of edits the user has made
    • registration: The time and date the user registered at 1.13+
    • emailable: Whether the user can and wants to receive e-mail through Special:Emailuser. "emailable" element: if it is missing - user cannot be emailed, if it is present and is an empty string: user can be emailed 1.14+
    • gender: Tags the gender of the user. Returns "male", "female", or "unknown" 1.16+

Example[edit]

Getting information about a list of users

Error Codes[edit]

None




list=users (us)

(main | query | users)
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0+

Get information about a list of users.

Parameters:
usprop

Which pieces of information to include:

blockinfo

Tags if the user is blocked, by whom, and for what reason.
groups
Lists all the groups each user belongs to.
groupmemberships
Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership.
implicitgroups
Lists all the groups a user is automatically a member of.
rights
Lists all the rights each user has.
editcount
Adds the user's edit count.
registration
Adds the user's registration timestamp.
emailable
Tags if the user can and wants to receive email through Special:Emailuser.
gender
Tags the gender of the user. Returns "male", "female", or "unknown".
centralids
Adds the central IDs and attachment status for the user.
cancreate

Indicates whether an account for valid but unregistered usernames can be created.
Values (separate with | or alternative): blockinfo, groups, groupmemberships, implicitgroups, rights, editcount, registration, emailable, gender, centralids, cancreate
usattachedwiki

With usprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

ususers

A list of users to obtain information for.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
ususerids

A list of user IDs to obtain information for.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
ustoken
Deprecated.

Use action=query&meta=tokens instead.

Values (separate with | or alternative): userrights