QueryPie 앱에 SCIM API 통합하기
팔로우사전 확인 사항
QueryPie의 SCIM API를 통합하려면 아래 사항이 필요합니다.
- QueryPie의 Owner 또는 System Admin 권한이 있는 관리자 계정이 필요합니다.
- QueryPie에 SSO 설정이 되어있어야 합니다.
개요
QueryPie의 SCIM API를 통합하면, PoPs에서 QueryPie의 사용자 정보들을 확인할 수 있습니다.
- QueryPie 사용자의 이름
- QueryPie 사용자의 이메일
- QueryPie 사용자의 상태
또한 아래와 같은 기능을 사용할 수 있습니다.
- 사용자 프로비저닝
사용자 프로비저닝 기능에 대한 자세한 안내는 다음 가이드를 참고해주세요.
프로비저닝(Provisioning)/디프로비저닝(Deprovisioning) 이란?
QueryPie 앱 인스턴스에 SCIM API 통합하기
- Megazone PoPs 워크스페이스 관리 콘솔에 관리자 계정으로 로그인합니다.
- QueryPie 앱 인스턴스 상세 페이지에서 [통합] 탭으로 이동하여 SCIM API의 [연결하기] 버튼을 클릭합니다.
- 기존에 통합된 정보가 없다면 [새 통합 및 연결]을 클릭합니다.
-
API 통합 페이지에서 API 인증 정보 및 추가 정보를 입력합니다.
[Access Token]과 [queryPieDomain]은 다음과 같은 방법으로 확인하여 입력합니다.
1. QueryPie 관리 콘솔에 관리자 계정으로 로그인합니다.
2. QueryPie 앱의 Administrator > General > User Management > Provisioning 경로로 이동합니다.
3. Provisioning 우측의 [Enable] 버튼을 클릭하여 SCIM 기능을 활성화합니다.
4. SCIM Endpoint에서 #{querypie-domain} 부분을 복사하여 [queryPieDomain]에 입력합니다.
(ex.#{querypie-domain}/api/scim/v2)
5. Access Token 발급을 위해 우측의 [Generate Token] 버튼을 클릭합니다.
6. 팝업창이 나타나면 해당 Access Token 값을 복사하여 [Access Token]에 입력합니다.
7. [Confirm] 버튼을 눌러 창을 닫습니다.
※ SCIM 전용 토큰 안내
-
- Access Token은 Generate Token 버튼을 통해 생성할 수 있으며, 최대 2개까지만 발급 가능합니다.
- 토큰 값은 생성 당시 1회에 한해 노출되며 이후에는 노출되지 않습니다.
- SCIM API전용으로만 사용 가능하며 /api/scim/v2 외 다른 엔드포인트 호출이 불가합니다.
- 새로 생성된 토큰은 발급일 yyyy-MM-dd 기준으로 1년까지만 유효합니다.
- 만료일이 도래하면 토큰은 Expired 처리되어 SCIM API 이용이 불가합니다.
- 관리자는 만료일이 도달하기 이전에 신규 토큰을 발급하여 기존의 IdP에 설정된 토큰을 변경해주어야 합니다.
- 토큰을 선택하고 DELETE 버튼을 클릭하여 토큰 삭제가 가능합니다.
- 만일 관리자가 토큰을 발급받았던 상태에서 Provisioning을 비활성화 했다가 다시 활성화 했을 경우, 기존의 토큰은 모두 비활성화 타이밍에 삭제 처리되므로, 관리자는 새로 유효한 토큰을 발급해야 합니다.
-
- API를 사용하기 위한 권한이 충분히 부여되어 있으면 연결 테스트 통과 다이얼로그가 노출됩니다.
※ 만약 통합에 실패하면 아래 사항을 확인한 뒤 다시 시도해주세요.
- API 통합 시 요구하는 정보를 정확히 입력했는지
- API 통합 시 인증한 관리자 계정에 충분한 권한이 부여되어 있는지 - API 통합이 완료되면, QueryPie 앱 인스턴스 내 [사용자] 탭에서 QueryPie 사용자 정보를 확인할 수 있습니다.
댓글
댓글 0개
댓글을 남기려면 로그인하세요.