Authorizers

Available in Classic and VPC

You can create and use an Authorizer as an authentication method when using APIs.

Authorizers interface and list

The following provides a basic overview of the Authorizers menu for using API Gateway:

Component	Description
① Menu name	Current menu name. Number of Authorizers in operation.
② Basic features	Create an Authorizer, view API Gateway details, refresh the page.
③ Post-creation features	Edit and Delete the Authorizers in operation.
④ Search bar	Enter the API Key name, then click to search for items.
⑤ Sort	Set the number of Usage Plans displayed per list page.
⑥ Authorizer list	View the list of active Authorizers. Authorizer ID: The ID of the created Authorizer (automatically assigned). Authorizer name: The name set when creating the Authorizer. Description: The description entered when creating the Authorizer.
⑦ Test	Conduct the created Authorizer test.

Create an Authorizer

To create an Authorizer:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the Authorizers menu.
3. Click [Create Authorizer].
4. Enter the Authorizer creation information and then click [Save].
   • Name: Enter the name of the Authorizer.
   • Description: Enter the description of the Authorizer.
   • Type: Select the service (type) supported by the Authorizer.
   • Region: Select the region where the selected service (type) is available.
   • Function name: Select the name of the Function created in the selected service (type).
     • Example: Cloud Action name of Cloud Functions.
   • Payload: Specify the request header or query string to be forwarded to the Authorizer for authentication processing.
     • To configure the payload, select the payload type (Header or Query String) from the drop-down menu, enter the variable value in the input field, and click .
     • To delete the configured payload, click .
5. Verify that the created Authorizer appears in the Authorizer list.

Edit an Authorizer

To edit an Authorizer:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the Authorizers menu.
3. In the Authorizer list, select the Authorizer to edit, then click [Edit].
4. On the Edit Authorizer interface, modify the settings, then click [Edit].
   • For descriptions of the configuration items, see Create an Authorizer.

Authorizer test

To test an Authorizer:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the Authorizer menu.
3. In the Authorizer list, click [Test] for the Authorizer you want to test.
4. In the Test popup, enter the configured payload values, then click [Test].
5. Review the test results, then click [Close].
   • To test with different payload values, enter the settings in the Payload component, then click [Test].

Delete an Authorizer

To delete an Authorizer:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the Authorizer menu.
3. In the Authorizer list, select the Authorizer to delete, then click [Delete].
4. In the Delete popup, review the details, enter the name of the Authorizer to delete in the input field, then click [Delete].

Authorizer usage and examples

You can configure and use the created Authorizer as an authentication method for API resource methods.

Using an Authorizer

For instructions on configuring the created Authorizer as an authentication method for API resource methods, see Create Method.

Authorizer usage examples

Examples of using an Authorizer are as follows:

• Cloud Functions

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