Extension:WikimediaApiPortalOAuth
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 | |
|
|
|
|
Quarterly downloads | Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin'). |
Public wikis using | Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin'). |
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
<translate> The extension can be retrieved directly from Git</translate> [?]:
- <translate> Browse code</translate>
- <translate> Some extensions have tags for stable releases.</translate>
- <translate> Browse tags</translate>
- <translate> Select the tag</translate>
- <translate> Click "snapshot"</translate>
- <translate> Each branch is associated with a past MediaWiki release.</translate> <translate> There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).</translate>
- <translate> Browse branches</translate>
- <translate> Select a branch name</translate>
- <translate> Click "<tvar name=1>⧼extdist-submit-version⧽</tvar>"</translate>
<translate> Extract the snapshot and place it in the <tvar name=name>extensions/WikimediaApiPortalOAuth/</tvar> 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: </translate>
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 yourextensions/
folder. - Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'WikimediaApiPortalOAuth' );
- File:OOjs UI icon check-constructive.svg <translate> Done</translate> - 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
|
<translate> Optional</translate> | 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.
File:Wikimedia-logo black.svg | <translate> This {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extension|skin}} is being used on one or more [[<tvar name=2>m:Special:MyLanguage/Wikimedia projects</tvar>|Wikimedia projects]].</translate> <translate> This probably means that the {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extension|skin}} is stable and works well enough to be used by such high-traffic websites.</translate> <translate> Look for this {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extension's|skin's}} name in Wikimedia's <tvar name=2>CommonSettings.php</tvar> and <tvar name=3>InitialiseSettings.php</tvar> configuration files to see where it's installed.</translate> <translate> A full list of the {{<tvar name=1>#ifeq:Extension|Extension</tvar>|extensions|skins}} installed on a particular wiki can be seen on the wiki's <tvar name=ver>Special:Version</tvar> page.</translate> |
- Pages with script errors
- Pages with broken file links
- Stable extensions
- Extensions without an image
- User interface extensions
- Extensions without a compatibility policy
- Extensions with manual MediaWiki version
- GPL licensed extensions
- Extensions in Wikimedia version control
- All extensions
- Extensions used on Wikimedia
- Wiki-specific extensions