한국어
  • logto
  • management-api
  • api
  • machine-to-machine
  • organization
  • user-profile
  • user-search
  • audit-log
  • migration

Logto 관리 API의 전체 잠재력 탐구

이 기사에서는 Logto 관리 API의 정의를 다시 강조하고, API가 작동하는 방식을 설명하며, 생산성을 높이고 더 많은 활용 사례를 탐색할 수 있는 일반적인 시나리오들을 소개합니다.

Guamian
Guamian
Product & Design

인프라 서비스로서 우리는 Logto 관리 API를 더 쉽게, 더 빠르게 사용할 수 있도록 노력하고 있습니다. 최근에 가이드와 튜토리얼을 업데이트했습니다. 이 기사에서는 Logto 관리 API의 정의를 다시 강조하고, API가 작동하는 방식을 설명하며, 생산성을 높이고 더 많은 활용 사례를 탐색할 수 있는 일반적인 시나리오들을 소개합니다.

Logto 관리 API란 무엇인가요

Logto 관리 API는 개발자에게 필요한 제품 요구 사항과 기술 스택에 맞게 구현을 맞춤화할 수 있는 힘을 제공하는 강력한 사전 빌드된 API 모음입니다.

이 API는 API 리소스 목록에 나열되어 있으며 삭제하거나 수정할 수 없습니다. Logto 관리자 콘솔에서 할 수 있는 모든 작업은 Logto 관리 API를 통해서도 가능합니다.

이 API의 식별자는 https://[tenant-id].logto.app/api 패턴으로 이루어져 있습니다.

Logto management API

Logto management API - 2

기본적으로 all 권한을 포함하며, Logto가 성장하면서 우리는 권한을 더 세분화할 예정입니다.

Logto 관리 API를 사용하면 다수의 시나리오에서 활용할 수 있는 Logto의 강력한 백엔드 서비스를 접근할 수 있습니다. 이용 가능한 API에 대해 자세히 알아보려면 Logto API 참조를 방문하세요.

관리 API 사용 시 일반적인 시나리오

우리 개발자들은 관리 API를 사용하여 많은 추가 기능들을 구현했습니다. 우리의 API는 매우 확장 가능하며 다양한 요구에 부합할 수 있다고 믿습니다. 여기 몇 가지 사례를 소개합니다. 이러한 시나리오는 Logto 관리자 콘솔에서 불가능하지만 관리 API를 통해 달성할 수 있습니다.

사용자 프로필을 커스텀 UI로 구현하기

Logto는 현재 사용자 프로필에 대해 사전 빌드된 UI 솔루션을 제공하지 않습니다. 사용자 프로필은 비즈니스와 제품 속성과 밀접하게 연결되어 있음을 인식하고 있으며, 최적의 접근 방식을 결정하는 동안 API를 활용하여 직접 솔루션을 만들어 보길 제안합니다. 예를 들어, 상호 작용 API, 프로필 API, 확인 코드 API를 활용해 사용자의 요구에 맞는 커스텀 솔루션을 개발할 수 있습니다. 이를 위한 튜토리얼과 가이드를 제공하는 전용 페이지 사용자 프로필도 준비했습니다.

흥미롭게도, Logto Cloud의 사용자 프로필 기능은 Logto 관리 API를 기반으로 구축되었습니다.

계정 설정

커스텀 UI로 조직 관리를 구현하기

만약 여러분이 조직 기능을 사용하여 다중 테넌트 앱을 구축하고 있다면, 초대와 멤버 관리와 같은 작업에 Logto 관리 API가 필요할 수 있습니다.

비슷하게, Logto Cloud 초대 및 협업 기능도 Logto 관리 API를 사용해 구축되었습니다.

조직

멤버를 조직에 초대

이를 확장하여 관리자와 멤버 양쪽 모두가 존재하는 SaaS 제품의 경우, Logto 관리 API를 통해 비즈니스 요구 사항에 맞춘 커스텀 관리자 포털을 만들 수 있습니다. 자세한 내용은 여기를 참고하세요.

고급 사용자 검색 구현하기

Logto 관리자 콘솔은 기본 검색과 필터링 기능을 지원합니다. 더 고급 옵션을 사용하여 비즈니스 요구 사항에 맞춘 사용자 관리 서비스를 제공하려면 Logto 관리 API를 사용할 수 있습니다. 이 API는 다음과 같은 고급 검색 옵션을 지원합니다:

  1. 퍼지 검색
  2. 정확한 일치
  3. 대소문자 구문 분석
  4. 특정 필드 지정

고급 사용자 검색에 대한 튜토리얼과 가이드를 확인하세요.

Logto 로그를 활용하여 맞춤형 서비스 구축하기

Logto의 감사 로그를 통해 사용자 활동과 이벤트를 쉽게 모니터링할 수 있습니다. 이는 다양한 사용자 관리 및 건강 체크 비즈니스 시나리오에 강력한 기반을 제공합니다.

감사 로그

관리 API를 활용하여 실시간 감사 로그 데이터를 접근할 수 있습니다. 이를 통해 Logto에서 얻은 로그 데이터를 활용해 자신만의 스키마 모델과 대시보드를 설계할 수 있습니다.

Logto로 사용자 마이그레이션 및 가져오기

관리 API를 사용하여 사용자 데이터를 손쉽게 가져올 수 있으며, 특히 Logto로의 마이그레이션을 원할 때 유용합니다.

사용자 데이터를 준비하고 비밀번호 해싱사용자 스키마를 설정한 후, 관리 API 연결을 설정하고 사용자 생성 API 호출을 통해 사용자 데이터를 가져옵니다. 마이그레이션에 대해 더 알아보려면 이 문서를 참조하세요.

Logto 관리 API에 접근하는 방법

M2M 앱 만들기

M2M 앱 유형을 선택하고 생성 프로세스를 시작합니다. 생성 후, M2M 롤을 할당할 수 있는 모듈로 이동하게 됩니다.

이름과 설명을 제공한 후, 롤을 할당하도록 요청하는 모듈을 보게 됩니다. 이 모듈은 모든 M2M 롤을 포함하며, Logto 아이콘이 표시된 롤은 Logto 관리 API 권한을 포함합니다.

M2M 롤 할당은 M2M 앱에서 Logto 관리 API 권한을 포함하게 됩니다.

M2M 롤 할당

기계 대 기계 통신을 사용하고 기계 대 기계 롤을 할당하는 이유는?

Logto에서는 API 키를 사용하는 대신 M2M(기계 대 기계) 통신을 통한 Logto 관리 API 호출을 허용합니다. 그 이유는 무엇일까요?

Logto는 고객 신원 관리를 다루며 OAuth 2.0 및 OpenID Connect와 같은 개방형 표준을 엄격히 준수합니다. M2M 토큰은 특정 스코프로 안전한 서버 간 상호 작용을 가능하게 하며, 정적 API 키보다 보안성이 더 뛰어납니다. API 키는 만료되지 않아 유출 시 더 큰 위험을 초래할 수 있는 반면, M2M 토큰은 정의된 만료 시간이 있어 악용 가능성을 최소화합니다.

Logto에서는 롤 기반 액세스 제어(RBAC)를 사용하여 Logto 관리 API에 대한 접근을 보호하고 관리합니다. 이 엔터티 다이어그램은 그것이 어떻게 작동하는지 보여줍니다.

권한, API 리소스, 롤, 기계 대 기계 애플리케이션 간의 관계.

권한, API 리소스, 롤, 기계 대 기계 애플리케이션 간의 관계.

액세스 토큰 가져오기

액세스 토큰 요청에 대한 기본 정보

M2M 앱은 HTTP 요청 엔터티 본문에 application/x-www-form-urlencoded 형식의 매개변수를 추가하여 토큰 엔드포인트로 POST 요청을 보내 액세스 토큰을 가져옵니다:

  • grant_type: client_credentials로 설정해야 합니다
  • resource: 접근하려는 리소스 지시자
  • scope: 접근 요청의 범위

또한 M2M 자격 증명을 포함하여 토큰 엔드포인트가 M2M 앱을 인증할 수 있도록 해야 합니다. 이는 기본 인증을 사용하여 Authorization 헤더를 추가하는 방식으로 이루어집니다. 여기서 사용자 이름은 앱 ID이며, 비밀번호는 앱 비밀입니다.

앱 ID와 앱 비밀은 M2M 애플리케이션 세부 정보 페이지에서 찾을 수 있습니다:

앱 자격 증명

Logto 관리 API 액세스 토큰 요청의 예시는 다음과 같습니다:

Logto 관리 API를 위한 액세스 토큰 가져오기

Logto는 내장된 “Logto 관리 API” 리소스를 제공합니다. 이는 Logto 관리 API에 접근할 수 있는 all 권한이 있는 읽기 전용 리소스입니다. API 리소스 목록에서 이 리소스를 확인할 수 있습니다. 리소스 API 지시자는 https://{YOUR_TENANT_ID}.logto.app/api 패턴으로 이루어져 있으며, 이 지시자를 액세스 토큰 요청 본문에 사용해야 합니다.

관리 API 상태

Logto 관리 API에 접근하기 전에, M2M 앱에 이 내장된 “Logto 관리 API” 리소스에서 all 권한을 포함하는 M2M 롤이 할당되어 있는지 확인하십시오.

이제 모든 것을 정리하여 요청을 보내세요:

토큰 응답

성공적인 응답 본문은 다음과 같습니다:

액세스 토큰을 사용하여 Logto 관리 API 접근하기

토큰 응답에 token_type 필드가 포함되어 있으며, 이는 Bearer로 고정되어 있습니다. 따라서 HTTP 헤더의 Authorization 필드에 Bearer 형식을 사용하여 액세스 토큰을 넣어야 합니다(Bearer YOUR_TOKEN).

이제 Logto 관리 API 엔드포인트 https://[your-tenant-id].logto.app/api로 요청을 보내어 Logto 내 모든 애플리케이션에 접근할 수 있습니다

관련 리소스

다음은 Logto 관리 API를 사용하는 데 대한 우리의 이전 인사이트와 전략을 다룬 관련 리소스입니다. 이 자료들은 모범 사례, 구현 팁, 사용 사례 등 다양한 측면을 다루어, 프로젝트에서 Logto 관리 API를 최대한 활용할 수 있도록 도와줍니다.