Authorizers
- Print
- PDF
Authorizers
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
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.
Field | Description |
---|---|
① Menu name | Name of the menu currently being viewed, number of authorizers in operation |
② Basic features | Create Authorizer, view detailed API Gateway information, page refresh |
③ Post-creation features | Edit and Delete authorizer in operation |
④ Search window | Enter the name of API key and click to search items |
⑤ Sort | Set the number of usage plans to display on list page |
⑥ Authorizer List | Checklist of authorizers in operation
|
⑦ Repetitiveness | Authorizer Test of created authorizer |
Create Authorizer
The following describes how to create an authorizer.
- From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
- Click the Authorizers menu.
- Click the [Create Authorizer] button.
- 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 .
- To delete a set payload, click .
- Check whether the created authorizer is displayed on the Authorizer list.
Modify Authorizer
The following describes how to edit authorizer.
- From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
- Click the Authorizers menu.
- Click to select the authorizer to edit from the Authorizer list, and then click the [Edit] button.
- Edit settings from the Edit Authorizer screen, and then click the [Edit] button.
- For more information on each item, refer to Create Authorizer.
Test Authorizer
The following describes how to test an authorizer.
- From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
- Click the Authorizer menu.
- Click to select the authorizer to test from the Authorizer list, and then click the [Test] button.
- Enter the set payload value in the Test pop-up window, and then click the [Test] button.
- 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.
- From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
- Click the Authorizer menu.
- Click to select the authorizer to delete from the Authorizer list, and then click the [Delete] button.
- 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?