MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=oathvalidate
(main | oathvalidate)
- This module is internal or unstable. Its operation may change without notice.
- This module requires read rights.
- This module only accepts POST requests.
- Source: OATHAuth
- License: GPL-2.0-or-later AND GPL-3.0-or-later
Validate a two-factor authentication (OATH) token.
Parameters:
- user
User to validate token for. Defaults to the current user.
- Type: user name
- totp
- Deprecated.
Two-factor authentication (OATH) token. Legacy, use "data" param instead
- data
JSON encoded data expected by the module currently activated for the user being authenticated
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
Examples:
- Validate a token for the current user
- api.php?action=oathvalidate&totp=123456&token=123ABC [open in sandbox]
- Validate a token for the user Example
- api.php?action=oathvalidate&user=Example&totp=123456&token=123ABC [open in sandbox]
- Validate JSON data for user Example
- api.php?action=oathvalidate&user=Example&data={"totp":"123456"}&token=123ABC [open in sandbox]