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=setglobalaccountstatus
(main | setglobalaccountstatus)
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: CentralAuth
- License: GPL-2.0-or-later
Set a global user's status.
Parameters:
- user
User to change the status of.
- This parameter is required.
- locked
Change whether this user is locked or not.
- One of the following values: Can be empty, or lock, unlock
- hidden
Change whether this user is not hidden, hidden from the global users list, or suppressed.
- One of the following values: Can be empty, or lists, suppressed
- reason
Reason for changing the user's status.
- statecheck
Optional MD5 of the expected current <username>:<hidden>:<locked>, to detect edit conflicts. Set <locked> to 1 for locked, 0 for unlocked.
- token
A "setglobalaccountstatus" token retrieved from action=query&meta=tokens
- This parameter is required.
Examples:
- Lock the global account for User:Example with reason "Spam"
- api.php?action=setglobalaccountstatus&user=Example&locked=lock&hidden=&reason=Spam [open in sandbox]
- Unlock and suppress the global account for User:Example with reason "I can"
- api.php?action=setglobalaccountstatus&user=Example&locked=unlock&hidden=suppressed&reason=I%20can [open in sandbox]