Authorizers
    • PDF

    Authorizers

    • PDF

    Article Summary

    Available in Classic and VPC

    When using an API, an authorizer can be created and be used as an authentication method.

    Authorizers screen and list

    The basics of using authorizers menus on API Gateway are as follows.

    apigw-apigw-authorizer-list_ko

    FieldDescription
    ① Menu nameName of the menu currently being viewed, number of authorizers in operation
    ② Basic featuresCreate Authorizer, view detailed API Gateway information, page refresh
    ③ Post-creation featuresEdit and Delete authorizer in operation
    ④ Search windowEnter the name of API key and click i-apigateway-find to search items
    ⑤ SortSet the number of usage plans to display on list page
    ⑥ Authorizer ListChecklist of authorizers in operation
    • Authorizer ID: ID of created authorizer (automatic designation)
    • Authorizer Name: authorizer name set during authorizer creation
    • Description: description of authorizer entered during authorizer creation
    RepetitivenessAuthorizer Test of created authorizer

    Create Authorizer

    The following describes how to create an authorizer.

    1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
    2. Click the Authorizers menu.
    3. Click the [Create Authorizer] button.
    4. Enter the authorizer creation information, and then click the [Save] button.
      • Name: Enter the name of authorizer
      • Description: Enter the description for the authorizer.
      • Type: Select the service (type) to be supported by the authorizer.
      • Region: Select the region where the supported service (type) is present.
      • Function Name: Select the created function name from the service (type).
        • Action name of Cloud Functions
      • Payload: Designate request header or query string to send to the authorizer for authentication processing.
        • To set the payload, select the Payload Type (Header, Query String) from the dropdown menu, enter the variable value in the input field, and then click i-apigateway-add.
        • To delete a set payload, click i-apigateway-delete.
    5. Check whether the created authorizer is displayed on the Authorizer list.

    Modify Authorizer

    The following describes how to edit authorizer.

    1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
    2. Click the Authorizers menu.
    3. Click to select the authorizer to edit from the Authorizer list, and then click the [Edit] button.
    4. Edit settings from the Edit Authorizer screen, and then click the [Edit] button.

    Test Authorizer

    The following describes how to test an authorizer.

    1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
    2. Click the Authorizer menu.
    3. Click to select the authorizer to test from the Authorizer list, and then click the [Test] button.
    4. Enter the set payload value in the Test pop-up window, and then click the [Test] button.
    5. Check the test result, and then click the [Close] button.
      • To enter a different payload value, enter the value in the Payload field, and then click the [Test] button.

    Delete Authorizer

    The following describes how to delete authorizer.

    Note

    A deleted authorizer cannot be recovered.

    1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
    2. Click the Authorizer menu.
    3. Click to select the authorizer to delete from the Authorizer list, and then click the [Delete] button.
    4. Check the information on the Delete pop-up window, enter the authorizer name to delete in the field, and then click the [Delete] button.

    Authorizer use and example

    The created authorizer can be set and be used as the API resource method authentication method.

    Authorizer use

    Refer to Create Method for information about how to set a created authorizer as the API resource method authentication method.

    Authorizer use example

    The following is an example for using an authorizer.

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

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.