OAuth 클라이언트 만들기 및 관리
OAuth는 권한 부여 및 위임을 위한 보안 프로토콜입니다. 이를 통해 타사 응용 프로그램이 최종 사용자 자격 증명을 공개하지 않고도 API 리소스에 액세스할 수 있습니다. OAuth 클라이언트는 권한 부여 코드를 요청하고 이를 액세스 토큰으로 교환한 후 해당 토큰을 사용하여 API를 통해 Qlik Cloud 콘텐츠에 액세스합니다.
OAuth 클라이언트 유형
OAuth 클라이언트는 사용자를 대신하여 Qlik Cloud의 리소스에 대한 액세스를 요청하는 웹 응용 프로그램 또는 소프트웨어입니다. OAuth는 응용 프로그램(클라이언트)과 권한 부여 서버(Qlik Cloud) 간의 권한 부여를 보호하기 위해 공개 클라이언트와 기밀 클라이언트의 두 가지 클라이언트 유형을 정의합니다.
Qlik Cloud는 특정 권한 부여 흐름을 사용하는 기존 웹(서버 측) 응용 프로그램용 기밀 클라이언트와 기본 및 단일 페이지 응용 프로그램용 공개 클라이언트를 지원합니다.
클라이언트 유형에 대한 공식 OAuth 2.0 사양은 RFC 6749 섹션 2.1: OAuth 2.0 클라이언트 유형을 참조하십시오.
공개 클라이언트
공개 클라이언트는 필요한 자격 증명의 기밀성을 유지할 수 없기 때문에 클라이언트 비밀을 사용하지 않는 응용 프로그램입니다. Qlik Cloud에는 사용자 인증이 필요한 포함된 분석 또는 Qlik Sense의 사용자 지정 시각화 확장 기능이 있는 단일 페이지 응용 프로그램(SPA)과 같은 프런트엔드 응용 프로그램이 포함됩니다.
기밀 고객
기밀 클라이언트는 클라이언트 ID와 클라이언트 비밀을 안전하게 저장하고, 이를 사용하여 권한 부여 서버에서 인증할 수 있습니다. 이러한 클라이언트는 클라이언트 비밀을 소유하고 있기 때문에 보호된 리소스에 액세스할 수 있습니다.
예: 사용자 액세스를 관리하거나 데이터 새로 고침 작업을 조정하기 위해 Qlik Cloud API와 상호 작용하는 보안 백엔드를 갖춘 웹 응용 프로그램입니다.
OAuth 권한 부여 흐름
Qlik은 두 가지 권한 부여 흐름(허가 유형)을 지원합니다.
-
권한 부여 코드 흐름: 기밀 클라이언트용.
-
PKCE(코드 교환을 위한 증명 키)를 사용한 권한 부여 코드 흐름: 공개 클라이언트용.
권한 부여 코드 흐름
이 흐름은 소스 코드가 공개적으로 노출되지 않은 서버 측 응용 프로그램에서 사용됩니다. 인증에는 클라이언트 비밀을 사용하고, 권한 부여 코드를 액세스 토큰으로 교환하는 과정이 포함됩니다. 이 흐름을 사용하는 웹 응용 프로그램은 토큰 교환 중에 클라이언트 비밀이 권한 부여 서버로 전달되기 때문에 서버 측이어야 합니다.
권한 부여 코드 흐름에 대한 자세한 내용은 공식 OAuth 2.0 문서인 권한 부여 코드 흐름을 참조하십시오.
PKCE를 사용한 권한 부여 코드 흐름
기본 및 단일 페이지 응용 프로그램은 소스 코드를 브라우저에서 디컴파일하거나 검사할 수 있기 때문에 클라이언트 비밀을 안전하게 저장할 수 없습니다. PKCE는 액세스 토큰을 가져오기 위해 코드 검증기를 사용하도록 요구하여 보안을 강화합니다.
PKCE를 통한 권한 부여에 대한 자세한 내용은 공식 OAuth 2.0 설명서를 참조하십시오: PKCE(코드 교환을 위한 증명 키)를 사용한 권한 부여 코드 흐름.
OAuth 범위 및 권한
OAuth 범위는 OAuth 클라이언트 응용 프로그램에 부여되는 액세스 수준을 정의합니다. 예를 들어, 액세스 토큰을 사용하면 리소스에 대한 전체 액세스를 허용하거나 읽기 전용 액세스로 제한할 수 있습니다. Qlik Cloud에서 범위는 사용할 수 있는 기능과 리소스에 대한 클라이언트 액세스를 제어합니다. 범위가 없으면 클라이언트는 어떤 리소스에도 액세스할 수 없습니다.
사용할 수 있는 OAuth 범위
테이블에 사용할 수 있는 범위와 관련 권한이 나열되어 있습니다.
범위 | 권한 |
---|---|
user_default | 계정 및 콘텐츠에 대한 전체 액세스 권한 |
admin_classic |
테넌트에 대한 전체 관리자 액세스 권한 관련 항목: 배포 및 관리Qlik Cloud 정보 메모단일 페이지 앱 또는 기본 클라이언트 유형에서는 지원되지 않습니다.
|
admin.apps |
테넌트의 모든 앱 읽기 및 관리 관련 항목: 앱 관리 |
|
테넌트의 모든 앱 내보내기 관련 항목: 앱 내보내기 |
|
테넌트의 모든 앱 읽기 |
admin.automations |
테넌트의 모든 자동화 읽기 및 관리 관련 항목: 자동화 관리 |
|
테넌트의 모든 자동화 읽기 |
admin.spaces |
테넌트의 모든 공간 읽기 및 관리 관련 항목: 공간 관리 |
|
테넌트의 모든 공간 읽기 |
앱 |
앱 읽기 및 관리 관련 항목: 앱 관리 |
|
앱 내보내기 관련 항목: 앱 내보내기 |
|
앱 읽기 |
자동화 |
자동화 읽기 및 관리 관련 항목: 자동화 관리 |
|
자동화 읽기 |
automl-experiments | ML 실험 읽기 및 관리 |
automl-deployments | ML 배포 읽기 및 관리 |
identity.email:read |
이메일 주소 읽기 관련 항목: Qlik Cloud의 ID 공급자 |
identity.name:read |
전체 이름 읽기 |
identity.picture:read |
프로필 사진 읽기 관련 항목: Qlik Cloud의 ID 공급자 |
identity.subject:read |
사용자 주체 식별자 읽기 |
spaces.data |
데이터 공간 읽기 및 관리 관련 항목: 공간 관리 |
|
데이터 공간 읽기 |
spaces.managed |
관리 공간 읽기 및 관리 관련 항목: 공간 관리 |
|
관리 공간 읽기 |
spaces.shared |
공유 공간 읽기 및 관리 관련 항목: 공간 관리 |
|
공유 공간 읽기 |
offline_access |
오프라인 상태에서 리소스에 액세스 정보 메모단일 페이지 앱 클라이언트 유형에서는 지원되지 않습니다.
|
OAuth 클라이언트 만들기
테넌트 관리자는 OAuth 페이지의 관리 활동 센터에서 OAuth 클라이언트를 관리합니다. OAuth 클라이언트를 사용하면 클라이언트 응용 프로그램을 Qlik Cloud와 통합하여 리소스에 안전하게 액세스할 수 있습니다.
OAuth 클라이언트에 대한 제한
다음과 같은 제한이 적용됩니다.
-
클라이언트당 최대 리디렉션 URL 수는 5개입니다.
-
클라이언트당 허용되는 최대 원본 수는 5개입니다.
-
클라이언트당 최대 클라이언트 비밀 수는 5개입니다.
-
테넌트당 최대 OAuth 클라이언트 수는 200개입니다.
OAuth 클라이언트를 만드는 단계
다음과 같이 하십시오.
-
관리 활동 센터에서 OAuth로 이동합니다.
-
새로 만들기를 클릭합니다.
-
클라이언트 유형을 선택합니다.
-
웹(기밀 고객용)
-
단일 페이지 앱 또는 기본(공개 고객용).
-
-
대화 상자에서 OAuth 클라이언트의 이름을 입력합니다.
-
설명을 추가합니다(선택 사항).
-
스크롤하거나 검색 필드를 사용하여 사용할 수 있는 범위를 선택합니다.
팁 메모모든 범위 또는 선택한 범위만 보려면 전체 및 선택 버튼을 사용합니다. -
OAuth 클라이언트 응용 프로그램에 대한 리디렉션 URL을 하나 이상 입력합니다(최대 5개). 그런 다음 추가를 클릭하여 리디렉션 URL을 허용 목록에 추가합니다.
-
권한 부여 서버가 클라이언트 응용 프로그램을 성공적으로 인증하고 권한을 부여한 후 사용자의 브라우저에 보내는 리디렉션 URL입니다. 예를 들어, https://www.exampleapp.com/oauth/callback에서는 /oauth/callback이 OAuth 공급자의 인증 콜백을 처리합니다.
-
Qlik Cloud는 해당 URL이 리디렉션 URL 허용 목록에 있는 경우에만 권한 부여가 성공한 후 사용자를 다시 응용 프로그램으로 리디렉션합니다.
-
URL은 도메인이 localhost가 아닌 경우 https://로 시작해야 하며, localhost인 경우에는 http://로 시작할 수 있습니다. 네이티브 앱은 exampleapp://과 같이 응용 프로그램별 링크 형식을 사용할 수도 있습니다.
-
-
웹 또는 단일 페이지 앱 클라이언트 유형의 경우 허용된 원본을 하나 이상 지정합니다(최대 5개).
-
URL이 허용된 원본 목록에 추가된 경우에만 응용 프로그램에 대한 액세스가 허용됩니다.
-
-
클라이언트 유형 웹의 경우 사용자 상호 작용 없이 자동화된 시스템 액세스를 위해 다음 옵션 중 하나를 활성화할 수 있습니다.
-
M2M(Machine-to-Machine) 허용: 사용자 개입 없이 컴퓨터 간 통신을 가능하게 합니다.
-
M2M 사용자 가장 허용: 인증 프로세스 중에 응용 프로그램이 사용자를 대신하여 인증할 수 있도록 허용합니다.
-
-
만들기를 클릭합니다.
-
클립보드에 복사를 클릭하여 나중에 사용할 수 있도록 클라이언트 ID 및 클라이언트 비밀을 저장합니다. 클라이언트 비밀을 안전하게 저장합니다.
정보 메모공개 클라이언트에는 클라이언트 비밀이 없습니다. -
완료를 클릭합니다.
특정 사용 사례를 위한 OAuth 클라이언트
OAuth 클라이언트 사용 사례는 다음 리소스를 참조하십시오.
-
Qlik 개발자 포털의 OAuth 개요: OAuth 사용 사례와 다양한 OAuth 유형에 대해 간략히 설명합니다.
-
Microsoft Excel용 Qlik 추가 기능에 대한 OAuth 클라이언트 만들기: Microsoft Excel에 대한 Qlik 추가 기능 설치를 위해 OAuth 클라이언트를 설정합니다.
-
앱 콘텐츠의 익명 포함을 위한 OAuth 클라이언트 만들기: 포함된 앱 콘텐츠에 익명으로 액세스할 수 있도록 OAuth 클라이언트를 만듭니다.
Microsoft Excel용 Qlik 추가 기능에 대한 OAuth 클라이언트 만들기
Microsoft Excel용 Qlik 추가 기능을 설치하려면 OAuth 클라이언트 구성이 필요합니다. 추가 기능은 보고서 개발자가 Qlik Sense 앱에서 표 형식 보고서의 출력을 제어하는 보고서 템플릿을 준비하는 데 사용됩니다.
추가 기능에서 OAuth가 작동하려면 OAuth 클라이언트가 아래 표시된 정확한 구성으로 구성되어야 합니다.
다음과 같이 하십시오.
-
관리 활동 센터의 Qlik Cloud에서 OAuth로 이동합니다.
-
새로 만들기를 클릭합니다.
-
클라이언트 유형 드롭다운 메뉴에서 단일 페이지 앱을 선택합니다. 더 많은 필드가 나타납니다.
-
이름을 삽입합니다. 설명은 선택 사항입니다.
-
최소한 user_default 범위를 포함하려면 확인란을 선택합니다. 구성에 다른 범위를 포함할 수 있지만 user_default가 없으면 설치가 작동하지 않습니다.
사용할 수 있는 각 범위에 대한 자세한 설명은 사용할 수 있는 OAuth 범위를 참조하십시오.
-
리디렉션 URL 추가 필드에 테넌트의 URL과 고정 문자열을 차례로 삽입합니다. /office-add-ins/oAuthLoginSuccess.html
결과는 다음과 같아야 합니다. https://YourServer/office-add-ins/oAuthLoginSuccess.html
-
추가를 클릭합니다.
-
허용된 원본 추가 필드에 테넌트 URL을 입력하고 추가를 클릭합니다.
-
만들기를 클릭합니다.
-
클라이언트 ID 복사 창이 나타납니다. 클라이언트 ID를 클립보드에 복사하도록 선택하거나 완료를 클릭하여 창을 닫을 수 있습니다.
OAuth 클라이언트를 만든 후 관리 활동 센터에서 업데이트된 매니페스트 XML 파일에 대한 링크를 가져옵니다. 설정 페이지로 이동하여 관리 활동 센터 내에서 공유 및 보고서 > Excel 추가 기능으로 이동합니다. 이 링크를 사용하여 추가 기능을 배포하고 설치합니다.
매니페스트 파일 생성, 추가 기능 배포 및 설치에 대한 자세한 내용은 다음을 참조하십시오.
앱 콘텐츠의 익명 포함을 위한 OAuth 클라이언트 만들기
qlik-embed를 사용하여 익명 액세스를 위한 앱 콘텐츠를 포함하려면 이 사용 사례에 맞게 특별히 설계된 유형의 OAuth 클라이언트를 만들어야 합니다.
다음과 같이 하십시오.
-
관리 활동 센터에서 OAuth 섹션으로 이동합니다.
-
새로 만들기를 클릭합니다.
-
클라이언트 유형 드롭다운 메뉴에서 익명 포함을 선택합니다.
-
OAuth 클라이언트의 이름을 입력하고 선택적으로 설명을 입력합니다.
-
허용된 원본에서 권한을 부여해야 하는 각 원본을 입력합니다. 이는 포함된 분석에 대한 정보를 검색하기 위해 Qlik Cloud 테넌트에 액세스할 도메인입니다.
각 URL을 삽입한 후 추가를 클릭합니다.
-
완료되면 만들기를 클릭합니다.
-
나중에 사용할 수 있도록 클라이언트 ID를 저장하려면 클립보드에 복사를 클릭합니다. qlik-embed에 앱 콘텐츠가 포함된 경우 필요합니다.
-
완료를 클릭합니다.
OAuth 클라이언트 편집
OAuth 클라이언트의 이름을 바꾸거나 설명을 업데이트하거나 리디렉션 URL을 관리할 수 있습니다.
다음과 같이 하십시오.
- 관리 활동 센터에서 OAuth로 이동합니다.
- 편집하려는 OAuth 클라이언트를 찾습니다.
-
을 클릭한 다음 편집을 선택합니다.
- 필요에 따라 OAuth 클라이언트 옵션을 수정합니다.
- 저장을 클릭합니다.
OAuth 클라이언트 삭제
OAuth 클라이언트가 더 이상 필요하지 않거나 액세스 권한을 취소할 때 삭제할 수 있습니다.
다음과 같이 하십시오.
-
관리 활동 센터에서 OAuth로 이동합니다.
-
제거하려는 OAuth 클라이언트를 하나 이상 선택한 다음 삭제를 클릭합니다.
- 삭제를 확인합니다.
OAuth 클라이언트 게시
OAuth 클라이언트는 초기에 이를 만든 테넌트에 바인딩됩니다. 하지만 동일한 지역 내의 다중 테넌트에서 OAuth 클라이언트를 공유하도록 구성할 수 있습니다. 이를 통해 타사 응용 프로그램은 여러 Qlik Cloud 테넌트에서 동일한 클라이언트 ID를 사용할 수 있습니다.
응용 프로그램 소유자는 테넌트 관리자의 상호 작용 없이 비밀을 순환하고 구성을 업데이트할 수 있습니다. 테넌트 관리자는 자격 증명을 관리하거나 게시된 클라이언트에 대한 구성 세부 정보를 알 필요가 없습니다.
다른 테넌트가 OAuth 클라이언트에 연결할 수 있도록 하려면 해당 클라이언트를 게시해야 합니다.
다음과 같이 하십시오.
- 관리 활동 센터에서 OAuth로 이동합니다.
- 게시하려는 OAuth 클라이언트를 찾습니다.
- 클라이언트 옆에 있는
을 클릭하고 게시를 선택합니다.
- 게시를 클릭하여 확인합니다.
OAuth 클라이언트가 게시되면 다른 테넌트가 외부에서 사용할 수 있게 됩니다. 사용자가 이 OAuth 클라이언트를 사용하는 외부 웹사이트로 이동하면, 활성 SaaS 세션이 이미 있는 경우를 제외하고 테넌트 호스트 이름과 사용자 자격 증명을 입력하라는 메시지가 표시됩니다.
최초 로그인에는 테넌트 관리자의 동의가 필요합니다. 승인되면 OAuth 클라이언트가 테넌트의 관리 활동 센터에 나타납니다.
동의 방법
기본적으로 Qlik Cloud는 인증 시 사용자에게 동의를 요청합니다. 특히 신뢰할 수 있는 응용 프로그램의 경우 프로세스를 간소화하기 위해 동의 방법을 "신뢰할 수 있음"으로 설정하여 동의 프롬프트를 건너뛸 수 있습니다.
동의에는 두 가지 옵션이 있습니다.
-
필수: OAuth 클라이언트가 새 범위를 요청할 때마다 사용자에게 동의를 요청합니다. 이 방법은 각 액세스 수준에 대한 명시적 사용자 승인을 보장합니다.
-
신뢰할 수 있음: 사용자에게 동의를 요청하지 않습니다. 이 옵션은 공개되지 않은 클라이언트에게만 제공됩니다. 게시된 클라이언트의 경우 다중 테넌트에서 보안을 유지하려면 동의 방법이 항상 필수입니다.
동의 방법 변경
OAuth 클라이언트에 대한 동의 방법을 변경하려면 다음을 수행합니다.
- 관리 활동 센터에서 OAuth로 이동합니다.
- OAuth 클라이언트에서
를 클릭하고 동의 방법 변경을 선택합니다.
- 필수 또는 신뢰할 수 있음을 선택한 다음 동의 방법 변경을 클릭합니다.
OAuth 구성 보기 및 복사
관리 활동 센터의 OAuth 섹션에서 OAuth 구성 보기를 선택하여 Qlik Cloud 테넌트에 대한 인증 세부 정보를 표시합니다. 이렇게 하면 OAuth 종료 지점과 설정이 포함된 코드 스니펫과 외부 응용 프로그램에서 사용하기 위해 복사할 수 있는 URL이 표시됩니다.
이 구성을 사용하면 Qlik Cloud를 타사 응용 프로그램과 통합하고, API 액세스를 자동화하거나, 포함된 분석에 대한 인증을 구성할 수 있습니다.
클라이언트 비밀 관리
클라이언트 비밀이 손상되거나 보안 정책에 따라 주기적 업데이트가 필요한 경우 비밀번호를 추가하거나 제거할 수 있습니다. 가동 중지 시간을 피하려면 여러 개의 클라이언트 비밀(최대 5개)을 추가하고 클라이언트 응용 프로그램을 업데이트한 다음 이전 비밀을 제거할 수 있습니다.
클라이언트 비밀 추가
다음과 같이 하십시오.
- 관리 활동 센터에서 OAuth로 이동합니다.
- OAuth 클라이언트를 찾습니다.
-
를 클릭하고 비밀 관리를 선택합니다.
- 새 클라이언트 비밀 생성을 클릭합니다.
-
클라이언트 비밀과 클라이언트 ID를 복사하여 안전하게 보관합니다.
정보 메모나중에 클라이언트 비밀에 액세스할 수 없습니다. - 닫기를 클릭합니다.
클라이언트 비밀 제거
다음과 같이 하십시오.
- 관리 활동 센터에서 OAuth로 이동합니다.
- OAuth 클라이언트를 찾습니다.
-
를 클릭하고 비밀 관리를 선택합니다.
- 클라이언트 비밀 옆에 있는
을 클릭합니다.
- 닫기를 클릭합니다.
Qlik Cloud에 액세스하기 위한 OAuth 클라이언트 응용 프로그램 구축
Qlik Cloud에 OAuth 클라이언트를 등록한 후에는 OAuth 클라이언트 응용 프로그램에서 연관된 클라이언트 ID와 클라이언트 비밀을 사용할 수 있습니다.
단계별 지침은 Qlik 개발자 포털의 OAuth 개요 섹션에 있는 자습서를 참조하십시오. 이 자습서에서는 인기 있는 프로그래밍 언어를 사용하여 클라이언트 응용 프로그램을 만드는 방법을 다룹니다.