Authorizers

Classic/VPC環境で利用できます。

APIの使用時に認証方法で Authorizerを作成して利用できます。

Authorizers画面とリスト

API Gatewayを利用するための Authorizersメニューの基本的な説明は、次の通りです。

apigw-apigw-authorizer-list_ko

領域	説明
① メニュー名	現在確認中のメニュー名、運用中の Authorizer数
② 基本機能	Authorizer作成、API Gateway詳細情報の確認、ページの更新
③ 作成後の機能	運用中の Authorizer変更と削除
④ 検索ボックス	API Key名を入力し、をクリックして項目を検索
⑤ ソート	リストのページごとに表示する Usage Plan数の設定
⑥ Authorizerリスト	運用中の Authorizerリストの確認 Authorizer ID: 作成した Authorizerの ID(自動付与) Authorizer名: Authorizerの作成時に設定した Authorizerの名前説明: Authorizers作成時に入力した Authorizerの説明
⑦ テスト	作成した Authorizerテスト

Authorizerの作成方法は以下の通りです。

NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
Authorizersメニューをクリックします。
[Authorizer作成] ボタンをクリックします。
Authorizer作成情報を入力して、 [保存] ボタンをクリックします。
- 名前: Authorizerの名前を入力
- 説明: Authorizerの説明を入力
- タイプ: Authorizerでサポートするサービス(タイプ)を選択
- 地域: サポートする当該サービス(タイプ)がある地域を選択
- Function名: 当該サービス(タイプ)で作成した Function名を選択
  - 例) Cloud Functionsのアクション(Action)名
- Payload: 認証処理のために Authorizerに伝達するためのリクエストヘッダーまたはクエリ文字列を指定
  - Payloadを設定するにはドロップダウンメニューから Payloadタイプ(Header、Query String)を選択した後、入力欄に変数値を入力してをクリックします。
  - 設定した Payloadを削除するにはをクリックします。
Authorizerリストに作成した Authorizerが表示されるか確認します。

Authorizerの変更方法は以下の通りです。

NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
Authorizersメニューをクリックします。
Authorizerリストで変更する Authorizerをクリックして選択し、 [変更] ボタンをクリックします。
Authorizerの変更画面で設定情報を変更し、 [変更] ボタンをクリックします。
- 設定項目に対する説明は Authorizer作成をご参照ください。

Authorizerのテスト方法は以下の通りです。

NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
Authorizerメニューをクリックします。
Authorizerリストでテストする Authorizerの [テスト] ボタンをクリックします。
テストポップアップで設定した Payload値を入力し、 [テスト] ボタンをクリックします。
テスト結果を確認して [閉じる] ボタンをクリックします。
- 他の Payload値を入力してテストするには、Payload領域に設定値を入力してから [テスト] ボタンをクリックします。

Authorizerの削除方法は以下の通りです。

参考

削除した Authorizerは復旧できません。

NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
Authorizerメニューをクリックします。
Authorizerリストで削除する Authorizerをクリックして選択し、 [削除] ボタンをクリックします。
削除ポップアップで内容を確認して、削除する Authorizer名を入力欄に入力し、 [削除] ボタンをクリックします。

作成した Authorizerを APIリソースのメソッドに認証手段として設定して利用できます。

作成した Authorizerを APIリソースのメソッドに認証手段として設定する方法は、メソッド作成をご参照ください。

Authorizerの利用例題は以下の通りです。

Cloud Functions

function main(params) {
   return {
      statusCode:(params.auth_key=='validKey') ? 200 : 401
   }
}