API:Allusers
Jump to navigation
Jump to search
 |
This page is part of the MediaWiki action API documentation. |
MediaWiki action API
- Introduction and quick start
- FAQ
- Formats
- Error reporting
- Restricting usage
- Cross-site requests
- Authentication
- Queries
- Searching (by title, content, coordinates...)
- Parsing wikitext and expanding templates
- Purging pages' caches
- Parameter information
- Changing wiki content
- Create and edit pages
- Move pages
- Merge pages
- Rollback
- Delete pages
- Restore deleted revisions
- (Un)protect pages
- (Un)block users
- (Un)watch pages
- Mark revisions of watched pages as visited
- Send email
- Patrol changes
- Import pages
- Change user group membership
- Upload files
- User options
- Tokens
- Page language
- More...
- Watchlist feed
- Wikidata
- Extensions
- Using the API in MediaWiki and extensions
- Miscellaneous
- Implementation
- Client code
- Asserting
| Allusers | ||
|---|---|---|
| Enumerate all registered users, ordered by username This module cannot be used as a Generator. |
||
| Prefix | au | |
| Required rights | none | |
| Post only? | No | |
| Generated help | Current | |
| Version added |
|
|
Contents
Parameters[edit]
aufrom: The user name to start enumerating fromauto: The user name to stop enumerating atauprefix: Search for all users that begin with this valueaudir: Direction to sort in. One value: ascending, descending. Default: ascendingaugroup: Limit users to given group name(s). Possible values: bot, sysop, bureaucrat (+ any other group that is defined on the wiki). This is different for every wiki; see the API help or action=paraminfo for a list of possible values.auexcludegroup: Exclude users in given group name(s). Can not be used together with 'group'.aurights: Limit users to given right(s)auprop: What pieces of information to include.blockinfo: Adds the information about a current block on the usergroups: Lists groups that the user is in. This uses more server resources and may return fewer results than the limitimplicitgroups: Lists all the groups the user is automatically inrights: Lists rights that the user haseditcount: Adds the edit count of the userregistration: Adds the timestamp of when the user registered if available (may be blank) 1.12+
aulimit: How many total user names to return. No more than 500 (5000 for bots) allowed. (Default: 10)auwitheditsonly: Only list users who have made editsauactiveusers: Only list users active in the last 30 days(s)
Example[edit]
Show a list of usernames starting with Y (or whichever sorts first after that)
| Result |
|---|
{
"batchcomplete": "",
"continue": {
"aufrom": "Y 20",
"continue": "-||"
},
"query": {
"allusers": [
{
"userid": 3634417,
"name": "Y"
},
{
"userid": 53928,
"name": "Y (usurped)"
},
{
"userid": 17490379,
"name": "Y . SOUNA"
},
{
"userid": 24519575,
"name": "Y 10bushehrii"
},
{
"userid": 32323885,
"name": "Y 11"
},
{
"userid": 7341556,
"name": "Y 12345 ut"
},
{
"userid": 31689152,
"name": "Y 1526"
},
{
"userid": 10969800,
"name": "Y 19"
},
{
"userid": 21703794,
"name": "Y 1977k"
},
{
"userid": 9302968,
"name": "Y 1praneeth"
}
]
}
}
|
Show a list of first 5 sysops
| Result |
|---|
{
"batchcomplete": "",
"continue": {
"aufrom": "AA",
"continue": "-||"
},
"query": {
"allusers": [
{
"userid": 111640,
"name": "(aeropagitica)"
},
{
"userid": 3030741,
"name": "28bytes"
},
{
"userid": 7044616,
"name": "5 albert square"
},
{
"userid": 8638440,
"name": "78.26"
},
{
"userid": 195987,
"name": "A Train"
}
]
}
}
|
Error Codes[edit]
| Code | Info |
|---|---|
| augroup-excludegroup | group and excludegroup cannot be used together |
Note[edit]
This api call is case sensitive, so aufrom=YA doesn't have the same results as aufrom=Ya.
