MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
action=linkaccount (link)
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: Discuss Contract Custom Solution
Link an account from a third-party provider to the current user.
The general procedure to use this module is:
- Fetch the fields available from Discuss Contract Custom Solution with amirequestsfor=link, and a csrf token from Discuss Contract Custom Solution.
- Present the fields to the user, and obtain their submission.
- Post to this module, supplying linkreturnurl and any relevant fields.
- Check the status in the response.
- If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
- If you received UI, present the new fields to the user and obtain their submission. Then post to this module with linkcontinue and the relevant fields set, and repeat step 4.
- If you received REDIRECT, direct the user to the redirecttarget and wait for the return to linkreturnurl. Then post to this module with linkcontinue and any fields passed to the return URL, and repeat step 4.
- If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
- linkrequests
Only use these authentication requests, by the id returned from Discuss Contract Custom Solution with amirequestsfor=link or from a previous response from this module.
- Separate values with | or Discuss Contract Custom Solution. Maximum number of values is 50 (500 for bots).
- linkmessageformat
Format to use for returning messages.
- One of the following values: html, wikitext, raw, none
- Default: wikitext
- linkmergerequestfields
Merge field information for all authentication requests into one array.
- Type: boolean (Discuss Contract Custom Solution)
- linkreturnurl
Return URL for third-party authentication flows, must be absolute. Either this or linkcontinue is required.
Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a linkcontinue request to this API module.
- linkcontinue
This request is a continuation after an earlier UI or REDIRECT response. Either this or linkreturnurl is required.
- Type: boolean (Discuss Contract Custom Solution)
- linktoken
A "csrf" token retrieved from Discuss Contract Custom Solution
- This parameter is required.
- *
- This module accepts additional parameters depending on the available authentication requests. Use Discuss Contract Custom Solution with amirequestsfor=link (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
- Start the process of linking to an account from Example.
- api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC [open in sandbox]