Authorizers
- 인쇄
- PDF
Authorizers
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
API 사용 시 인증 방법으로 Authorizer를 생성하여 이용할 수 있습니다.
Authorizers 화면 및 목록
API Gateway 이용을 위한 Authorizers 메뉴의 기본적인 설명은 다음과 같습니다.
영역 | 설명 |
---|---|
① 메뉴명 | 현재 확인 중인 메뉴 이름, 운영 중인 Authorizer 개수 |
② 기본 기능 | Authorizer 생성, API Gateway 상세 정보 확인, 페이지 새로 고침 |
③ 생성 후 기능 | 운영 중인 Authorizer 수정 및 삭제 |
④ 검색창 | API Key 이름 입력한 후 을 클릭해 항목 검색 |
⑤ 정렬 | 목록 페이지당 표시할 Usage Plan 개수 설정 |
⑥ Authorizer 목록 | 운영 중인 Authorizer 목록 확인
|
⑦ 테스트 | 생성한 Authorizer 테스트 |
Authorizer 생성
Authorizer를 생성하는 방법은 다음과 같습니다.
- 네이버 클라우드 플랫폼 콘솔에서 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 수정
Authorizer을 수정하는 방법은 다음과 같습니다.
- 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
- Authorizers 메뉴를 클릭해 주십시오.
- Authorizer 목록에서 수정할 Authorizer를 클릭해 선택한 후 [수정] 버튼을 클릭해 주십시오.
- Authorizer 수정 화면에서 설정 정보를 수정한 후 [수정] 버튼을 클릭해 주십시오.
- 설정 항목에 대한 설명은 Authorizer 생성을 참고해 주십시오.
Authorizer 테스트
Authorizer를 테스트하는 방법은 다음과 같습니다.
- 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
- Authorizer 메뉴를 클릭해 주십시오.
- Authorizer 목록에서 테스트할 Authorizer의 [테스트] 버튼을 클릭해 주십시오.
- 테스트 팝업 창에서 설정한 Payload 값을 입력한 후 [테스트] 버튼을 클릭해 주십시오.
- 테스트 결과를 확인하고 [닫기] 버튼을 클릭해 주십시오.
- 다른 Payload 값을 입력한 후 테스트하려면 Payload 영역에 설정값을 입력한 후 [테스트] 버튼을 클릭해 주십시오.
Authorizer 삭제
Authorizer을 삭제하는 방법은 다음과 같습니다.
참고
삭제한 Authorizer는 복구할 수 없습니다.
- 네이버 클라우드 플랫폼 콘솔에서 Services > Application Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
- Authorizer 메뉴를 클릭해 주십시오.
- Authorizer 목록에서 삭제할 Authorizer를 클릭해 선택한 후 [삭제] 버튼을 클릭해 주십시오.
- 삭제 팝업 창에서 내용을 확인하고, 삭제할 Authorizer 이름을 입력란에 입력한 후 [삭제] 버튼을 클릭해 주십시오.
Authorizer 이용 및 예제
생성한 Authorizer를 API 리소스의 메서드에 인증 수단으로 설정하고 이용할 수 있습니다.
Authorizer 이용
생성한 Authorizer를 API 리소스의 메서드에 인증 수단으로 설정하는 방법은 메서드 생성을 참고해 주십시오.
Authorizer 이용 예제
Authorizer 이용 예제는 다음과 같습니다.
- Cloud Functions
function main(params) { return { statusCode:(params.auth_key=='validKey') ? 200 : 401 } }
이 문서가 도움이 되었습니까?