Kakao i Account::Adapter Agent

페이지 이동경로

카카오 i 서비스 연동

카카오 i 서비스 시스템(Kakao i Service System)은 카카오 i 서비스의 백엔드 체계를 나타내며, 카카오 i 계정, 카카오워크, 카카오 i 클라우드 등의 여러 ‘카카오 i 서비스’들과 이들의 계정을 상호 연동해주는 ‘Adapter 서버’로 구성됩니다.

카카오 i 서비스 시스템에서 카카오 i 계정(Kakao i Account)은 카카오 i 계정을 기반으로 제공되는 다양한 카카오 i 서비스들(카카오워크, 카카오 i 클라우드 등)과 연동하여 사용자 인증/권한 관리 등과 같은 통합 계정 관리와 계정의 생성, 변경, 삭제와 같은 계정의 라이프 사이클을 관리하고 리소스 접근에 대한 권한을 제어합니다.

Adapter 서버는 고객사의 정보(계정, 로그인 및 조직도 정보 등) 연동을 위해, 해당 정보가 필요한 시점에 고객사 계정과 조직도 시스템에 능동적으로 정보를 요청합니다. 이를 위해 고객사는 카카오 i 서비스 시스템이 고객사 정보에 접근할 수 있도록 Adapter Agent API를 구현한 Adapter Agent 서버를 구축해야 합니다.

카카오 i 서비스 - 고객사 시스템 연동 그림카카오 i 서비스 - 고객사 시스템 연동

동작 프로세스

  1. 카카오 i 서비스가 고객사의 정보가 필요할 때(데이터 동기화, 로그인 정합성 검증 등) Adapter 서버를 호출합니다.

  2. Adapter 서버는 Adapter Agent API를 호출합니다.

  3. Adapter Agent 서버는 고객사 계정 및 조직도 시스템에 접근하여 정보를 획득한 뒤 반환합니다.

  4. Adapter 서버는 Adapter Agent API의 응답을 받아 카카오 i 서비스로 전달합니다.

계정 연동 설정

고객사에서 사용할 로그인 계정과 카카오 i 계정을 동기화하는 설정 방법은 다음과 같습니다. 계정 연동 설정은 카카오 i 서비스에서 조직 생성을 완료한 후에 수행할 수 있습니다.

  1. 카카오 i 계정을 사용하는 서비스(ex. 카카오워크)에서 조직을 생성합니다.

    안내
    조직을 최초 생성한 자는 슈퍼 관리자 권한을 획득합니다. 슈퍼 관리자는 해당 조직과 멤버의 관리를 책임지는 최상위 권한으로 조직당 한 명만 존재합니다. 카카오 i 계정에 존재하는 권한 정보와 관련된 자세한 설명은 카카오 i 계정 관리자 > 권한 정보 챕터를 참고하시기 바랍니다.
  2. 카카오 i 계정 관리자 서비스 사이트의 계정 연동 설정 메뉴에서 계정 연동을 신청합니다.

    • 계정 연동 신청 승인은 영업일 기준으로 약 3일 정도 소요될 수 있습니다.
    안내
    계정 연동에 관련된 자세한 설명은 카카오 i 계정 관리자 > 계정 연동 설정 챕터를 참고하시기 바랍니다.
  3. 조직에서 사용할 로그인 방식 정보와 조직 ID(org_id)를 카카오 i 담당자에게 전달합니다.

    Kakao i Account에서 지원하는 로그인 방식
    구분 로그인 방식 설명
    카카오 i 계정 ID/Password 카카오엔터프라이즈 IAM 서버에서 관리하는 계정 방식
    - 계정 체계를 가지지 않는 조직을 위한 기본 타입
    BUILT IN Adapter Agent 서버를 통해 카카오엔터프라이즈 IAM 서버에 고객정보를 연동하는 계정 타입
    - 계정 체계는 없지만 계정 동기화로 사용자 관리, 초기 비밀번호가 설정된 형태 이용
    - 동기화 API 구현 필요
    CUSTOM adapter.identifyUser 고객사 계정 체계를 통해서 ID/PW 방식으로 로그인하는 계정 타입
    - LDAP: 조직 내부에서 사용되는 계정 방식으로, Key 값 등록 필요
    - 동기화 API 구현 필요
    OAuth 2.0 adapter.extractUser 고객사 계정 체계를 통해 OAuth 2.0 방식으로 로그인하는 계정 타입
    - 동기화 API 구현 필요
    SAML 2.0 고객사 계정 체계를 통해 SAML 2.0 방식으로 로그인하는 계정 타입
    - 동기화 API 구현 필요
    • 조직 ID(org_id) 값은 조직 관리 > 계정 연동 설정 메뉴에서 카카오 i 계정 탭을 클릭했을 때 표시되는 URL에서 마지막 여섯 자리 숫자입니다.
      조직 ID 확인 그림조직 ID 확인
  4. 고객사의 Adapter 서버와 Adapter Agent 서버 동기화를 위해 카카오 i 계정 관리자 서비스 > 조직 관리 > 계정 연동 설정 메뉴에서 IP 정보를 등록합니다.

    안내
    카카오 i 계정을 사용하는 경우 IP 등록은 필요하지 않습니다.
    IP 등록 정보
    항목 도메인 IP 주소 설명
    NAT IP
    (OUTBOUND)
    - 210.109.2.200 Adapter Server가 Adapter Agent Server로 요청할 때, 사용되는 IP
    IP
    (INBOUND)
    adapter.kakao.ai 210.109.141.2 Adapter Agent Server가 Adapter Server로 요청하는 IP
  5. Adapter Agent API 목록을 참고하여 구현할 Capability를 선택하고, 해당 Capability의 API를 구현합니다.

    주의
    Agent Capability의 getAgentCapabilities API와 User Capability의 getUserMetadata API를 구현하지 않으면 계정 연동 설정이 제한됩니다.
  6. 고객사 서버와 카카오 i 계정을 동기화하기 위해 카카오 i 계정 관리자 서비스 사이트 > 조직 관리 > 계정 연동 설정 메뉴에서 계정 연동 설정을 완료합니다.

    안내
    계정 연동 설정 방법은 고객사에서 연동한 로그인 방식에 따라 다릅니다. 자세한 설명은 카카오 i 계정 관리자 문서를 참고하시기 바랍니다.

연동 시스템 구성

연동 시스템 구성 요소
구분 설명
Adapter 서버 카카오 i 서비스의 Gateway 역할을 하는 서버
Adapter Agent 서버 고객사의 계정 시스템과 연동하기 위한 API 서버
- 고객사가 구현해야 하는 Agent 서버

인터페이스

카카오 i 서비스 시스템과 고객사가 구현한 Adapter Agent 서버 간 계정 및 조직도 정보를 연동하는 인터페이스입니다.

API 목록
구분 설명
Adapter Agent API 카카오 i 서비스 시스템이 고객사 정보에 접근할 수 있도록 정보를 제공
- 고객사가 Adapter Agent 서버에 구현해야 하는 API
Adapter API Adapter가 Adapter Agent에 정보 제공
- 카카오 i 서비스 시스템에서 제공하는 API
- Adapter Agent 서버를 구현한 고객사의 로그인 방식에 대한 정보 제공
   ex) LDAP, OAuth 2.0, SAML 2.0

관련 문서

Adapter Agent Kakao i Account 개발 프로세스 Kakao i Account API 레퍼런스 Kakao i Account 카카오 i 계정 관리자 Kakao i Account

이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.