MediaWiki API help
This is an auto-generated MediaWiki Action API documentation 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.
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): CM_admin, CM_auditor_ext, CM_editor, CM_reviewer, Employee, HR_reader, IMS_editor, IMS_reviewer, WCAG, WORKFLOW_APPROVER, bot, bureaucrat, csmoderator, interface-admin, review, reviewer, suppress, sysop, wiki_-shared_admin, wiki_-shared_editor, wiki_-shared_reader, wiki_-shared_reviewer, wiki_ASM_admin, wiki_ASM_editor, wiki_ASM_reader, wiki_ASM_reviewer, wiki_CM_admin, wiki_CM_editor, wiki_CM_reader, wiki_CM_reviewer, wiki_Certification_admin, wiki_Certification_editor, wiki_Certification_reader, wiki_Certification_reviewer, wiki_FIN_admin, wiki_FIN_editor, wiki_FIN_reader, wiki_FIN_reviewer, wiki_HR_admin, wiki_HR_editor, wiki_HR_reader, wiki_HR_reviewer, wiki_Helpdesk_admin, wiki_Helpdesk_editor, wiki_Helpdesk_reader, wiki_Helpdesk_reviewer, wiki_IIT_admin, wiki_IIT_editor, wiki_IIT_reader, wiki_IIT_reviewer, wiki_IMS_admin, wiki_IMS_editor, wiki_IMS_reader, wiki_IMS_reviewer, wiki_MnS_admin, wiki_MnS_editor, wiki_MnS_reader, wiki_MnS_reviewer, wiki_PW_admin, wiki_PW_editor, wiki_PW_reader, wiki_PW_reviewer, wiki_RnD_admin, wiki_RnD_editor, wiki_RnD_reader, wiki_RnD_reviewer, wiki__global_admin, wiki__global_editor, wiki__global_reader, wiki__global_reviewer, wiki_w_admin, wiki_w_editor, wiki_w_reader, wiki_w_reviewer, workflow_CERTIFICATION_approver
- Maximum number of values is 50 (500 for clients that are 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 that are allowed higher limits).
- Default: infinite
- remove
Remove the user from these groups.
- Values (separate with | or alternative): CM_admin, CM_auditor_ext, CM_editor, CM_reviewer, Employee, HR_reader, IMS_editor, IMS_reviewer, WCAG, WORKFLOW_APPROVER, bot, bureaucrat, csmoderator, interface-admin, review, reviewer, suppress, sysop, wiki_-shared_admin, wiki_-shared_editor, wiki_-shared_reader, wiki_-shared_reviewer, wiki_ASM_admin, wiki_ASM_editor, wiki_ASM_reader, wiki_ASM_reviewer, wiki_CM_admin, wiki_CM_editor, wiki_CM_reader, wiki_CM_reviewer, wiki_Certification_admin, wiki_Certification_editor, wiki_Certification_reader, wiki_Certification_reviewer, wiki_FIN_admin, wiki_FIN_editor, wiki_FIN_reader, wiki_FIN_reviewer, wiki_HR_admin, wiki_HR_editor, wiki_HR_reader, wiki_HR_reviewer, wiki_Helpdesk_admin, wiki_Helpdesk_editor, wiki_Helpdesk_reader, wiki_Helpdesk_reviewer, wiki_IIT_admin, wiki_IIT_editor, wiki_IIT_reader, wiki_IIT_reviewer, wiki_IMS_admin, wiki_IMS_editor, wiki_IMS_reader, wiki_IMS_reviewer, wiki_MnS_admin, wiki_MnS_editor, wiki_MnS_reader, wiki_MnS_reviewer, wiki_PW_admin, wiki_PW_editor, wiki_PW_reader, wiki_PW_reviewer, wiki_RnD_admin, wiki_RnD_editor, wiki_RnD_reader, wiki_RnD_reviewer, wiki__global_admin, wiki__global_editor, wiki__global_reader, wiki__global_reviewer, wiki_w_admin, wiki_w_editor, wiki_w_reader, wiki_w_reviewer, workflow_CERTIFICATION_approver
- Maximum number of values is 50 (500 for clients that are 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.
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]