User:Liz Kariuki/Sandbox/API:Linkaccount

This page is part of the MediaWiki Action API documentation.

MediaWiki Action API
Basics
Etiquette and usage guidelines All query modules All page properties All list modules All meta modules Output formats
Authentication
Get tokens for data modifying operations Login Logout Verifying authentication (assertions)
Accounts and Users
Create an account Block or unblock a user Get info about the current user Get the current user's watchlist as a feed Change user options Change user group membership Send an email
Page Operations
Create and edit a page Get the contents of a page Upload a file Import a page Delete a page Parse content of a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More...
Search
Search wiki pages by title (OpenSearch) Advanced search for wiki pages by title or text Search wiki pages near a location Search for a language name Perform a prefix search for page titles
Developer Utilities
Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation Strategy
Tutorials
Action API Tutorial Article ideas generator Nearby places viewer Picture of the day viewer Holidays viewer
v · d · e

MediaWiki version:

≥ 1.11

Link an account from a third-party provider to the current user.

API documentation

[edit ]

The following documentation is the output of Special:ApiHelp/linkaccount, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

action=linkaccount (link)

(main | linkaccount)

This module requires write rights.
This module only accepts POST requests.
Source: MediaWiki
License: GPL-2.0-or-later

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 action=query&meta=authmanagerinfo with amirequestsfor=link, and a csrf token from action=query&meta=tokens .
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.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Linkaccount

Specific parameters:

Other general parameters are available.

linkrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=link or from a previous response from this module.

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

linkmessageformat

Format to use for returning messages.

One of the following values: html, none, raw, wikitext

Default: wikitext

linkmergerequestfields

Merge field information for all authentication requests into one array.

Type: boolean (details)

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 (details)

linktoken

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

*

This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=link (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

Example:

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]

Examples

[edit ]

Example 1: Fetch all the links in a page

[edit ]

GET request

[edit ]

{==== Response ====

{
"query":{
"pages":[
{
"pageid":736,
"ns":0,
"title":"Albert Einstein",
"links":[
{
"ns":0,
"title":"2dF Galaxy Redshift Survey"
},
{
"ns":0,
"title":"A priori and a posteriori"
},
{
"ns":0,
"title":"Aage Bohr"
},
...
]
}
]
}
}

Sample code

[edit ]

User:Liz Kariuki/Sandbox/API:Linkaccount/Sample code 1

Example 2: Fetch missing links

[edit ]

Get request to fetch missing or red links on Wikipedia:Most-wanted_articles. Two steps to do so:

Make a GET request to the Action API to return all links embedded on the provided page.
From further extraction, obtain those links that are missing and don't yet exist on English Wikipedia.

generator=links query module's submodule links used as a generator module to get a set of links embedded on a page.

GET request

[edit ]

api.php?action=query&format=json&generator=links&titles=Wikipedia:Most-wanted_articles&gpllimit=20 [try in ApiSandbox]

Response

[edit ]

Response

{
"batchcomplete":"",
"continue":{
"continue":"gplcontinue||",
"gplcontinue":"297177|0|1965_in_sumo"
},
"query":{
"pages":{
"-1":{
"missing":"",
"ns":0,
"title":"(viii)"
},
"-10":{
"missing":"",
"ns":0,
"title":"1954 in sumo"
}
...
}
}
}

Sample code

[edit ]

get_red_links.py
User:Liz Kariuki/Sandbox/API:Linkaccount/Sample code 2

Parameter history

[edit ]

v1.19: Introduced pldir
v1.17: Introduced pltitles
v1.13: Introduced pllimit, plcontinue

API documentation

action=linkaccount (link)

Examples

Example 1: Fetch all the links in a page

GET request

Sample code

Example 2: Fetch missing links

GET request

Response

Sample code

Parameter history

See also