API:User group membership
![]() |
This page is part of the MediaWiki API documentation. |
Language: | English • Deutsch |
---|
Quick overview:
- Quick start guide
- FAQ
- Tutorial
- Formats
- Error reporting
- Restricting usage
- Cross-site requests
- Authentication
- Queries
- Search suggestions
- Parsing wikitext and expanding templates
- Purging pages' caches
- Parameter information
- Changing wiki content
- Watchlist feed
- Wikidata
- Extensions
- Using the API in MediaWiki and extensions
- Miscellaneous
- Implementation
- Client code
Contents
Token[edit | edit source]
MediaWiki version: | = 1.16 |
To change a user's group membership, a userrights token is required. This token is not equal to the edit token: it depends on the name of the user whose rights are being changed. A userrights token can be obtained as follows: Obtaining a userrights token
Result |
---|
The following content has been placed in a collapsed box for improved usability. |
<?xml version="1.0"?> <api> <query> <users> <user name="Bob" userrightstoken="6c291fe7b3336ebc912f21cfa076b3d9+\" /> </users> </query> </api> |
The above content has been placed in a collapsed box for improved usability. |
Adding users to and removing them from groups[edit | edit source]
Users can be added to groups or removed from them with action=userrights.
Parameters[edit | edit source]
user
: The name of the user whose rights you want to change.token
: The token obtained in the previous request. Take care to urlencode the '+' as '%2B'.add
: A pipe-separated list of groups you want to add the user to. Groups you're not allowed to add and groups the user is already in will be silently ignoredremove
: A pipe-separated list of groups you want to remove the user from. Groups you're not allowed to remove and groups the users isn't in will be silently ignoredreason
: Reason for the change (optional).
Sample request[edit | edit source]
Note: In this example, all parameters are passed in a GET request just for the sake of simplicity. However, action=userrights requires POST requests; GET requests will cause an error. Removing Bob from the bureaucrat group, and adding him to the sysop and bot groups
Result |
---|
The following content has been placed in a collapsed box for improved usability. |
<?xml version="1.0" encoding="utf-8"?> <api> <userrights user="Bob"> <removed> <group>bureaucrat</group> </removed> <added> <group>sysop</group> <group>bot</group> </add> </userrights> </api> |
The above content has been placed in a collapsed box for improved usability. |
NOTE: If you don't have permission to add/remove users to/from groups, you'll get a result with empty <added />
and <removed />
tags rather than an error message, because all the groups you specified were silently ignored.
Possible errors[edit | edit source]
All errors are formatted as:
<error code="code" info="info">
- code: nouser
- info: The user parameter must be set
- code: nosuchuser
- info: User ``user'' doesn't exist
- This may happen when trying to change an anonymous user's rights.
- info: User ``user'' doesn't exist
- code: notoken
- info: The token parameter must be set
- code: badtoken
- info: Invalid token
- code: readonly
- info: The wiki is in read-only mode
- In read-only mode, absolutely nothing can be changed.
- info: The wiki is in read-only mode