API:Restricting API usage/de

MediaWiki Action API
Grundlagen Alle Anfragen-Module Die Eigenschaften einer Seite erhalten Seiten auflisten, die ein Kriterium erfüllen Modulparameterinformationen erhalten Metainformationen über das Wiki und seine Benutzer erhalten Authentifizierung Tokens für datenmodifizierende Aktionen abrufen. Login Logout Benutzerkonten und Benutzer Benutzerkonto erstellen Benutzer sperren/entsperren Get info about the current user Die Beobachtungsliste des aktuellen Benutzers als Feed erhalten Benutzereinstellungen ändern Benutzergruppenmitgliedschaft ändern Eine E-Mail senden Seitenoperationen Den Inhalt einer Seite parsen Eine Seite erstellen und bearbeiten Eine Datei hochladen Eine Seite importieren Eine Seiten löschen Eine Seite beobachten oder nicht mehr beobachten Den Zwischenspeicher einer Seite leeren Eine Seite zurücksetzen Eine Seite verschieben Eine Seite oder Bearbeitung kontrollieren Versionen gelöschter Seiten wiederherstellen Den Schutzstatus einer Seite ändern Seitensprache verändern Mehr… Suche Nach einen Titel oder Text suchen Ergebnisse in einem OpenSearch-Format abrufen Suche nach Wikiseiten in der Nähe eines Ortes Suche nach einer Sprache Eine Präfixsuche nach Seitentitel durchführen Entwicklerwerkzeuge Zugriffsbibliotheken Cross-site requests Ein API-Modul in einer Erweiterung kreieren Die API in MediaWiki und Erweiterungen verwenden Restricting API usage Localisation Implementation Strategy Tutorials Action API Tutorial Article ideas generator Nearby places viewer Picture of the day viewer Holidays viewer

There are several ways to restrict usage of (certain parts of) the API to certain groups of users, or to disable it altogether. Some of these require changing group permissions.

Disabling the entire API

You can disable the API as a whole by setting $wgEnableAPI = false; in LocalSettings.php . The API is enabled by default.

This configuration setting was deprecated starting with MediaWiki 1.31.0 and will be removed in future versions meaning that disabling the API will no longer be possible.

Disabling the write API

You can disable all write modules by setting $wgEnableWriteAPI = false; in LocalSettings.php. The write API is enabled by default as of MediaWiki 1.14, and disabled by default in older versions.

This configuration setting was deprecated starting with MediaWiki 1.31.0 and will be removed in future versions meaning that disabling the write API will no longer be possible.

Restricting access to the write API

You can deny certain groups the right to use the write API by denying them the writeapi right. By default, all groups have the writeapi right. However, both the writeapi right and $wgEnableWriteAPI = true; are required in order to use the write API.

Disabling modules

You can disable individual modules for all users by adding a line to LocalSettings.php. Exactly what to add depends on the type of module you want to disable:

• Für action= Module, benutze $wgAPIModules ['modulename'] = 'ApiDisabled';
• For prop= modules, use $wgAPIPropModules ['modulename'] = 'ApiQueryDisabled';
• For list= modules, use $wgAPIListModules ['modulename'] = 'ApiQueryDisabled';
• For meta= modules, use $wgAPIMetaModules ['modulename'] = 'ApiQueryDisabled';

Beispiel

To disable anyone who isn't a sysop from using action=edit:

if ( !in_array( 'sysop', $wgUser->getGroups() ) ) {
	$wgAPIModules['edit'] = 'ApiDisabled';
}

To limit the access of an API action, add the following hook for ApiCheckCanExecute :

static function onApiCheckCanExecute( $module, $user, &$message ) {
    $moduleName = $module->getModuleName();
    if (
        $moduleName == 'action' &&
        !in_array( 'group', $user->getGroups() )
    ) {
        $message = 'apierror-action-notallowed';
        return false;
    }
    return true;
}

Replace 'action', 'group' and 'apierror-action-notallowed' with the appropriate values.