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.
Parameters:
- user
User.
- Type: user, by any of user name 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): About_the_Almanac:Admin, Albania:Admin, Austria:Admin, Belgium:Admin, BosniaAndHerzegovina:Admin, Bulgaria:Admin, Country_profiles:Admin, Croatia:Admin, Cyprus:Admin, Czechia:Admin, Denmark:Admin, Description_of_pictograms:Admin, Estonia:Admin, EuropeanUnion:Admin, Finland:Admin, France:Admin, Germany:Admin, Greece:Admin, How_to_read:Admin, Hungary:Admin, Iceland:Admin, Imprint:Admin, Ireland:Admin, Italy:Admin, Kosovo:Admin, Latvia:Admin, Legal_information_concerning_the_contents:Admin, Lithuania:Admin, Luxembourg:Admin, Main_Page:Admin, Malta:Admin, Montenegro:Admin, Netherlands:Admin, NorthMacedonia:Admin, Norway:Admin, Poland:Admin, Portugal:Admin, Privacy_policy:Admin, Romania:Admin, Russia:Admin, Serbia:Admin, Slovakia:Admin, Slovenia:Admin, Spain:Admin, Special:SpecialPages:Admin, Superadmin, Sweden:Admin, Switzerland:Admin, Türkiye:Admin, USA:Admin, Ukraine:Admin, UnitedKingdom:Admin, administrator, bot, bureaucrat, interface-admin, onlyreadgroup, push-subscription-manager, smwadministrator, smwcurator, smweditor, suppress, sysop, translator
- Maximum number of values is 50 (500 for clients allowed higher limits).
- 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 allowed higher limits).
- Default: infinite
- remove
Remove the user from these groups.
- Values (separate with | or alternative): About_the_Almanac:Admin, Albania:Admin, Austria:Admin, Belgium:Admin, BosniaAndHerzegovina:Admin, Bulgaria:Admin, Country_profiles:Admin, Croatia:Admin, Cyprus:Admin, Czechia:Admin, Denmark:Admin, Description_of_pictograms:Admin, Estonia:Admin, EuropeanUnion:Admin, Finland:Admin, France:Admin, Germany:Admin, Greece:Admin, How_to_read:Admin, Hungary:Admin, Iceland:Admin, Imprint:Admin, Ireland:Admin, Italy:Admin, Kosovo:Admin, Latvia:Admin, Legal_information_concerning_the_contents:Admin, Lithuania:Admin, Luxembourg:Admin, Main_Page:Admin, Malta:Admin, Montenegro:Admin, Netherlands:Admin, NorthMacedonia:Admin, Norway:Admin, Poland:Admin, Portugal:Admin, Privacy_policy:Admin, Romania:Admin, Russia:Admin, Serbia:Admin, Slovakia:Admin, Slovenia:Admin, Spain:Admin, Special:SpecialPages:Admin, Superadmin, Sweden:Admin, Switzerland:Admin, Türkiye:Admin, USA:Admin, Ukraine:Admin, UnitedKingdom:Admin, administrator, bot, bureaucrat, interface-admin, onlyreadgroup, push-subscription-manager, smwadministrator, smwcurator, smweditor, suppress, sysop, translator
- Maximum number of values is 50 (500 for clients allowed higher limits).
- 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):
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]