Authorizers

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

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

Authorizers画面とリスト

API Gatewayの利用のためのAuthorizersメニューの基本的な説明は以下のとおりです。

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

Authorizerの作成

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

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

Authorizerの修正

Authorizerの修正方法は以下のとおりです。

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

Authorizerテスト

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

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

Authorizerの削除

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

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

Authorizerの利用と例

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

Authorizerの利用

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

Authorizerの利用例

Authorizerの利用例は以下のとおりです。

• Cloud Functions

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