MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

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-or-later

Change a user's group membership.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:User_group_membership

Specific parameters:

Other general parameters are available.

user

User.

Type: user, by any of username and user ID (e.g. "#12345")

userid

Deprecated.

Specify user=#ID instead.

Type: integer

add

Add the user to these groups, or if they are already a member, update the expiry of their membership in that group.

Values (separate with | or alternative): approver-AR, approver-EST, approver-EWS, approver-FAC, approver-GHS, approver-HEA, approver-LT, approver-LV, approver-OTH, approver-PF, approver-PLG, approver-PU, approver-SEC, approver-SPT, approver-STI, approver-STU, approver-TAB, approver-TCS, approver-TD, approver-WS, bot, bureaucrat, editor-AR, editor-EST, editor-EWS, editor-FAC, editor-GHS, editor-HEA, editor-LT, editor-LV, editor-OTH, editor-PF, editor-PLG, editor-PU, editor-SEC, editor-SPT, editor-STI, editor-STU, editor-TAB, editor-TCS, editor-TD, editor-WS, interface-admin, super-approver, suppress, sysop

expiry

Expiry timestamps. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If only one timestamp is set, it will be used for all groups passed to the add parameter. Use infinite, indefinite, infinity, or never for a never-expiring user group.

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

Default: infinite

remove

Remove the user from these groups.

Values (separate with | or alternative): approver-AR, approver-EST, approver-EWS, approver-FAC, approver-GHS, approver-HEA, approver-LT, approver-LV, approver-OTH, approver-PF, approver-PLG, approver-PU, approver-SEC, approver-SPT, approver-STI, approver-STU, approver-TAB, approver-TCS, approver-TD, approver-WS, bot, bureaucrat, editor-AR, editor-EST, editor-EWS, editor-FAC, editor-GHS, editor-HEA, editor-LT, editor-LV, editor-OTH, editor-PF, editor-PLG, editor-PU, editor-SEC, editor-SPT, editor-STI, editor-STU, editor-TAB, editor-TCS, editor-TD, editor-WS, interface-admin, super-approver, suppress, sysop

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.

tags

Change tags to apply to the entry in the user rights log.

Values (separate with | or alternative):

watchuser

Watch the user's user and talk pages.

Type: boolean (details)

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]
Add user SometimeSysop to group sysop for 1 month.: api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [open in sandbox]