IMAP/CalDAV 로그인 API
고객사에서는 "그림2 OAuth 2.0 기반 API 인증"의 3~4 단계에 해당하는 로직을 구현하여 NAVER WORKS에서 사용할 수 있도록 API로 제공한다. 이 API는 사용자가 IMAP/CalDAV으로 로그인할 수 있도록 NAVER WORKS에서 사용한다.
고객사 SSO 시스템에서는 Base64로 인코딩된 아이디, 비밀번호를 받아서 인증을 확인한 후, Authorization Code를 발급하여 반환한다.
주의
- 만약 고객사 SSO 시스템에 계정 잠금 등의 기능이 구현되어 있으면 IMAP/CalDAV 로그인 시 사용자의 실수로 계정이 잠길 수 있으므로 API에서 이 부분을 예외 처리하는 것이 좋다.
Request URL {#auth-request-url}
비밀번호를 취급하므로 반드시 SSL(https)을 사용해야 한다.
제작한 Request URL은 Developer Console의 SSO > WORKS as SP 설정에서 IMAP/CalDAV Login API에 등록한다.
그림 11 OAuth 2.0 기반 IMAP/CalDAV 로그인 API 등록
HTTP Method {#auth-request-method}
GET
Request {#auth-request-parameter}
| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| String | Y | 메일 주소(NAVER WORKS ID)(Base64로 인코딩 후 UTF-8로 URL 인코딩한 값) | |
| password | String | Y | 비밀번호(Base64로 인코딩 후 UTF-8로 URL 인코딩한 값) |
Response {#auth-response}
응답 형식은 JSON이다.
| 속성 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| code | String | Y (성공 시) | Authorization Code Access Token을 발급하는 데 사용되는 일회성 코드 |
| error | String | Y (실패 시) | 실패 시 반환하는 오류 코드 |
| error_description | String | Y (실패 시) | 실패 시 반환하는 오류 설명 |
참고
- NAVER WORKS에서는 code가 빈 값이면 로그인 실패로 처리한다.