API:User group membership

From MediaWiki.org
(Redirected from API:Userrights)
Jump to: navigation, search
Language: English  • Deutsch • 日本語
Tools clipart.png This page is part of the MediaWiki action API documentation.
MediaWiki APIsAPI:Main page

MediaWiki action API

v · d · e

Token[edit]

A user rights token is required and can since MediaWiki 1.24 be obtained by action=query&meta=tokens&type=userrights.

For compatibility, the token used in the web UI is also accepted.

Previously, to change a user's group membership, the required token would depend on the name of the user whose rights were being changed. A user rights token could be obtained as follows: Obtaining a user rights token

Adding users to and removing them from groups[edit]

Users can be added to groups or removed from them with action=userrights.

Parameters[edit]

  • 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 ignored
  • remove: 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 ignored
  • reason: Reason for the change

Sample request[edit]

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

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]

All errors are formatted as:

<error code="code" info="info">
Code Info
nouser The user parameter must be set
nosuchuser User "user" doesn't exist
Note: This may happen when trying to change an anonymous user's rights.
notoken The token parameter must be set
badtoken Invalid token
readonly The wiki is in read-only mode
Note: In read-only mode, absolutely nothing can be changed.

action=userrights

(main | userrights)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0+

Change a user's group membership.

Parameters:
user

User name.

Type: user name
userid

User ID.

Type: integer
add

Add the user to these groups.

Values (separate with | or alternative): bot, sysop, bureaucrat, steward, accountcreator, import, transwiki, ipblock-exempt, oversight, autopatrolled, translationadmin, flow-bot, confirmed, checkuser
remove

Remove the user from these groups.

Values (separate with | or alternative): bot, sysop, bureaucrat, steward, accountcreator, import, transwiki, ipblock-exempt, oversight, autopatrolled, translationadmin, flow-bot, confirmed, checkuser
reason

Reason for the change.

Default: (empty)
token

A "userrights" token retrieved from action=query&meta=tokens

For compatibility, the token used in the web UI is also accepted.

This parameter is required.
Examples:
Add user FooBot to group bot, and remove from groups sysop and bureaucrat.
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [open in sandbox]
Add the user with ID 123 to group bot, and remove from groups sysop and bureaucrat.
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [open in sandbox]