API:API の使用の制限

MediaWiki 操作 API
基本 クエリの下位モジュール群 ページ属性を取得 条件に合致するページの列挙 変数の情報を取得 ウィキと利用者のメタ情報を取得 認証 データ変更を伴う操作用のトークンの取得 ログイン ログアウト 利用者とアカウント アカウントを作成 利用者のブロックとブロック解除 Get info about the current user 現在の利用者のウォッチリストをフィードとして取得 利用者オプションを変更 利用者の所属グループの変更 メールの送信 ページのオペレーション ページ内容の構文解析 ページの作成/編集 ファイルのアップロード ページの取り込み ページの削除 ページのウォッチ/ウォッチ解除 ページのキャッシュの破棄 ページの巻き戻し ページの移動 ページや更新の巡回 削除されたページの版の復元 ページの保護レベルの変更 ページ言語の変更 その他... 検索 記事や文の検索 結果を OpenSearch 形式で取得 周辺に関連するウィキを検索 言語を検索 ページ名の前方一致検索 開発者向けユーティリティ ライブラリにアクセス クロスサイト リクエスト 拡張機能内での API モジュールの作成 MediaWiki および拡張機能内での API の使用 API の使用の制限 地域化 Implementation Strategy チュートリアル 操作 API のチュートリアル 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.

API 全体の無効化

$wgEnableAPI = false; in LocalSettings.php 中の $wgEnableAPI = false; を設定することでAPI全体を無効化することができます。 APIは既定では有効です。

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.

書き込み API の無効化

LocalSettings.php 中の $wgEnableWriteAPI = false; を設定することで、すべての書き込みモジュールを無効化することができます。 書き込みAPIはMediaWiki 1.14以降は既定で有効となっていて、それより古いバージョンでは既定で無効となっています。

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.

書き込み API へのアクセス制限

You can deny certain groups the right to use the write API by denying them the writeapi right. 既定では、すべてのグループが writeapi 権限を持っています。 ただし、writeapi 権限と $wgEnableWriteAPI = true; の両方が書き込みAPIを使用するために必要です。

モジュールの無効化

LocalSettings.php に行を追加することで、すべての利用者に対してモジュールを個別に無効化できます。 Exactly what to add depends on the type of module you want to disable:

• action= モジュールの場合は、$wgAPIModules ['modulename'] = 'ApiDisabled'; を使用してください
• prop= モジュールの場合は、$wgAPIPropModules ['modulename'] = 'ApiQueryDisabled'; を使用してください
• list= モジュールの場合は、$wgAPIListModules ['modulename'] = 'ApiQueryDisabled'; を使用してください
• meta= モジュールの場合は、$wgAPIMetaModules ['modulename'] = 'ApiQueryDisabled'; を使用してください

例

管理者以外の 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.