旧バージョンのドキュメントを参照しています。最新のドキュメントはこちらをご参照ください。

Dev Portalでキー認証を有効にする

Kong Dev Portalは、APIキーまたは Key Authentication を使用して、完全または部分的に認証できます。ユーザーは登録時に固有のキーを入力し、このキーを使用して Dev Portalにログインします。

Dev PortalのKey Authenticationは、次の3つの方法で有効にできます。

Kong Manager 経由
コマンドライン経由
Kong構成ファイル経由

警告: Dev Portalで認証を有効にするには、Sessionプラグインを使用する必要があります。これが適切に設定されていない場合、開発者はログインできません。詳細情報はDev Portalのセッションを参照してください。

ポータルSession構成の有効化

portal_session_conf={ "cookie_name": "portal_session", "secret": "CHANGE_THIS", "storage": "kong" }

テスト中にHTTPを使用する場合は、構成に"cookie_secure": falseを含めます。

portal_session_conf={ "cookie_name": "portal_session", "secret": "CHANGE_THIS", "storage": "kong", "cookie_secure": false }

Kong Manager経由のKey Authの有効化

Dev Portalの設定ページに移動します。
認証タブで 認証プラグイン を探します。
ドロップダウンから Key Authentication を選択します。
変更を保存 をクリックします。

警告 Dev Portal認証が有効になっている場合、コンテンツファイルはロールが適用されるまで認証されません。*ロールで始まるsettings.txtとdashboard.txtは、この例外です。詳細については、開発者のロールとコンテンツ権限セクションを参照してください。

コマンドラインによるKey Auth の有効化

Dev Portal の認証プロパティを直接パッチするには、次のコマンドを実行します。

curl -X PATCH http://localhost:8001/workspaces/<workspace NAME id="sl-md0000000"> \
  --data "config.portal_auth=key-auth" >  > **警告** Dev Portal認証が有効になっている場合、コンテンツファイルはロールが適用されるまで認証されません。`*`ロールで始まる`settings.txt`と`dashboard.txt`は、この例外です。詳細については、<a href="/gateway/3.4.x/kong-enterprise/dev-portal/authentication/developer-permissions">開発者のロールとコンテンツ権限</a>セクションを参照してください。

Kong.confによるKey Authの有効化

Kongでは、 portal_authプロパティを持つKong構成ファイルに default authentication pluginを設定することができます。

kong.conf ファイルのプロパティを以下のように設定します。

portal_auth="key-auth"

これにより、ワークスペースに関係なく、初期化時にすべてのDev Portalがデフォルトで Key Authenticationを使用するように設定されます。