MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=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.
- user
User name.
- Type: user name
- userid
User ID.
- 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): bot, sysop, bureaucrat, devwiki_user, dave_user, a000022_user, a000022_user_rw, a000022_approval, a000022_sdv09_user, a000022_sdv09_user_rw, a000022_sdv09_approval, a000057_user, a000077_user, a000171_user, a000180_user, a000011_user, a000011_user_rw, a000011_approval, a000011_sdv18_user, a000011_sdv18_user_rw, a000011_sdv18_approval, a000011_sdv30_user, a000011_sdv30_user_rw, a000011_sdv30_approval, a000115_user, a000016_user, a000058_user, a000056_user, a000025_user, a000063_user, a000063_user_rw, a000063_approval, a000063_salcr_user, a000063_salcr_user_rw, a000063_salcr_approval, a000298_user, a000298_user_rw, a000298_approval, a000299_user, a000299_user_rw, a000299_approval, a000249_user, a000249_user_rw, a000249_approval, a000322_user, a000322_user_rw, a000322_approval, a000322_bds_user, a000322_bds_user_rw, a000322_bds_approval, wikifarmtest_user, wikifarmtest_user_rw, wikifarmtest_approval, a000380_user, a000380_user_rw, a000380_approval, a000380_som_ups_user, a000380_som_ups_user_rw, a000380_som_ups_approval, a000266_user, a000266_user_rw, a000266_approval, a000266_prometeus_user, a000266_prometeus_user_rw, a000266_prometeus_approval, a000298_buddylight_user, a000298_buddylight_user_rw, a000298_buddylight_approval, a000327_user, a000327_user_rw, a000327_approval, a000327_sdv07_user, a000327_sdv07_user_rw, a000327_sdv07_approval, a000054_user, a000054_user_rw, a000054_approval, a000054_nairobi_user, a000054_nairobi_user_rw, a000054_nairobi_approval, a000036_user, a000036_user_rw, a000036_approval, a000036_diva_user, a000036_diva_user_rw, a000036_diva_approval, a000485_user, a000485_user_rw, a000485_approval, a000485_sdv20_user, a000485_sdv20_user_rw, a000485_sdv20_approval, a000032_user, a000032_user_rw, a000032_approval, a000019_user, a000019_user_rw, a000019_approval, a000019_sdv26_user, a000019_sdv26_user_rw, a000019_sdv26_approval, a000029_user, a000029_user_rw, a000029_approval, a000029_sdv29_user, a000029_sdv29_user_rw, a000029_sdv29_approval, a000028_user, a000028_user_rw, a000028_approval, a000028_gsd_user, a000028_gsd_user_rw, a000028_gsd_approval, a000767_user, a000767_user_rw, a000767_approval, a000767_sdv28_user, a000767_sdv28_user_rw, a000767_sdv28_approval
- Maximum number of values is 50 (500 for bots).
- 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 bots).
- Default: infinite
- remove
Remove the user from these groups.
- Values (separate with | or alternative): bot, sysop, bureaucrat, devwiki_user, dave_user, a000022_user, a000022_user_rw, a000022_approval, a000022_sdv09_user, a000022_sdv09_user_rw, a000022_sdv09_approval, a000057_user, a000077_user, a000171_user, a000180_user, a000011_user, a000011_user_rw, a000011_approval, a000011_sdv18_user, a000011_sdv18_user_rw, a000011_sdv18_approval, a000011_sdv30_user, a000011_sdv30_user_rw, a000011_sdv30_approval, a000115_user, a000016_user, a000058_user, a000056_user, a000025_user, a000063_user, a000063_user_rw, a000063_approval, a000063_salcr_user, a000063_salcr_user_rw, a000063_salcr_approval, a000298_user, a000298_user_rw, a000298_approval, a000299_user, a000299_user_rw, a000299_approval, a000249_user, a000249_user_rw, a000249_approval, a000322_user, a000322_user_rw, a000322_approval, a000322_bds_user, a000322_bds_user_rw, a000322_bds_approval, wikifarmtest_user, wikifarmtest_user_rw, wikifarmtest_approval, a000380_user, a000380_user_rw, a000380_approval, a000380_som_ups_user, a000380_som_ups_user_rw, a000380_som_ups_approval, a000266_user, a000266_user_rw, a000266_approval, a000266_prometeus_user, a000266_prometeus_user_rw, a000266_prometeus_approval, a000298_buddylight_user, a000298_buddylight_user_rw, a000298_buddylight_approval, a000327_user, a000327_user_rw, a000327_approval, a000327_sdv07_user, a000327_sdv07_user_rw, a000327_sdv07_approval, a000054_user, a000054_user_rw, a000054_approval, a000054_nairobi_user, a000054_nairobi_user_rw, a000054_nairobi_approval, a000036_user, a000036_user_rw, a000036_approval, a000036_diva_user, a000036_diva_user_rw, a000036_diva_approval, a000485_user, a000485_user_rw, a000485_approval, a000485_sdv20_user, a000485_sdv20_user_rw, a000485_sdv20_approval, a000032_user, a000032_user_rw, a000032_approval, a000019_user, a000019_user_rw, a000019_approval, a000019_sdv26_user, a000019_sdv26_user_rw, a000019_sdv26_approval, a000029_user, a000029_user_rw, a000029_approval, a000029_sdv29_user, a000029_sdv29_user_rw, a000029_sdv29_approval, a000028_user, a000028_user_rw, a000028_approval, a000028_gsd_user, a000028_gsd_user_rw, a000028_gsd_approval, a000767_user, a000767_user_rw, a000767_approval, a000767_sdv28_user, a000767_sdv28_user_rw, a000767_sdv28_approval
- Maximum number of values is 50 (500 for bots).
- 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):
- 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]