Extension:WikimediaApiPortalOAuth

MediaWiki extensions manual

WikimediaApiPortalOAuth Release status: stable
Implementation	User interface
Description	Extension to provide user interface and API client support to the Wikimedia API Portal
Author(s)	Dejan Savuljesku, Robert Vogel
MediaWiki	1.35+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgWikimediaApiPortalOAuthMetaApiURL $wgWikimediaApiPortalOAuthMetaRestURL
Added rights wikimediaapiportaloauth-manage-oauth
Quarterly downloads	2 (Ranked 135th)
Translate the WikimediaApiPortalOAuth extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The WikimediaApiPortalOAuth extension is designed to connect the API Portal with the OAuth server on Meta-Wiki by providing a user interface for creating and managing OAuth 2.0 clients. This extension requires the ability to connect to a wiki acting as an OAuth controller and running OAuth 1.36 or later.

Download

The extension can be retrieved directly from Git ^[?]:

• Browse code
• Some extensions have tags for stable releases.
  • Browse tags
  • Select the tag
  • Click "snapshot"
• Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).
  • Browse branches
  • Select a branch name
  • Click "Continue"

Extract the snapshot and place it in the extensions/WikimediaApiPortalOAuth/ directory of your MediaWiki installation.

If you are familiar with Git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikimediaApiPortalOAuth.git

Installation

WikimediaApiPortalOAuth requires MediaWiki 1.35 or later.

• Download and place the file(s) in a directory called WikimediaApiPortalOAuth in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php:

wfLoadExtension( 'WikimediaApiPortalOAuth' );

•  Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

On the wiki where WikimediaApiPortalOAuth is installed, set $wgWikimediaApiPortalOAuthMetaRestURL to the URL for rest.php on the OAuth controller wiki. For example, in the case of the beta Wikimedia API Portal, the OAuth controller wiki is the beta instance of Meta-Wiki (https://meta.wikimedia.beta.wmflabs.org/w/rest.php). To allow WikimediaApiPortalOAuth to make requests to the OAuth server, set $wgRestAllowCrossOriginCookieAuth to true on the OAuth controller wiki.

Variable name	Required?	Default	Type	Description
$wgWikimediaApiPortalOAuthMetaRestURL	Optional	https://meta.wikimedia.org/w/rest.php	String	URL for rest.php on the OAuth controller wiki

Usage

The Special:AppManagement page provides a simplified set of options for creating and managing OAuth 2.0 clients. The extension supports creating two types of OAuth 2.0 clients:

• owner-only clients
• clients with authorization code, client credentials, and refresh token grant types

For more information about OAuth 2.0, visit OAuth/For Developers.