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=globaluserrights

(main | globaluserrights)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: CentralAuth
  • License: GPL-2.0-or-later

Add/remove a user to/from global groups.

Specific parameters:
Other general parameters are available.
user

Global username.

Type: user, by any of username އަދި user ID (e.g. "#12345")
userid
Deprecated.

Global user ID.

Type: integer
add

Add the user to these global groups.

Values (separate with | or alternative): abusefilter-helper، abusefilter-maintainer، apihighlimits-requestor، captcha-exempt، founder، global-bot، global-deleter، global-flow-create، global-interface-editor، global-ipblock-exempt، global-rollbacker، global-sysop، global-temporary-account-viewer، new-wikis-importer، oathauth-tester، ombuds، recursive-export، staff، steward، sysadmin، u4c-member، vrt-permissions، wmf-email-block-override، wmf-researcher
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 global groups.

Values (separate with | or alternative): abusefilter-helper، abusefilter-maintainer، apihighlimits-requestor، captcha-exempt، founder، global-bot، global-deleter، global-flow-create، global-interface-editor، global-ipblock-exempt، global-rollbacker، global-sysop، global-temporary-account-viewer، new-wikis-importer، oathauth-tester، ombuds، recursive-export، staff، steward، sysadmin، u4c-member، vrt-permissions، wmf-email-block-override، wmf-researcher
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

This parameter is currently unused.

Values (separate with | or alternative):
Examples:
Add user FooBot to global group "bot", and remove from global groups "sysop" and "bureaucrat"
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [open in sandbox]
Add the global user with ID 123 to global group "bot", and remove from global groups "sysop" and "bureaucrat"
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [open in sandbox]