Workfront 통합을 위한 OAuth2 애플리케이션 만들기
Adobe Workfront 관리자는 Workfront 인스턴스에 대한 OAuth2 응용 프로그램을 만들 수 있으며, 이를 통해 다른 응용 프로그램에서 Workfront에 액세스할 수 있습니다. 그런 다음 사용자는 다른 응용 프로그램에 Workfront 데이터에 액세스할 수 있는 권한을 부여할 수 있습니다. 이러한 방식으로 자체 애플리케이션을 포함하여 원하는 애플리케이션을 제공합니다.
OAuth2 응용 프로그램을 만들 때 클라이언트 ID 및 클라이언트 암호를 생성합니다. 그런 다음 사용자는 API 호출에서 클라이언트 ID를 사용하여 만든 애플리케이션과 통합할 수 있습니다.
- 사용자 자격 증명(인증 코드 흐름)을 사용하여 OAuth2 응용 프로그램을 구성하고 사용하는 방법에 대한 지침은 인증 코드 흐름을 사용하여 조직의 사용자 지정 OAuth2 응용 프로그램 구성 및 사용을 참조하십시오.
- 서버 인증(JWT 흐름)을 사용하여 OAuth2 애플리케이션을 구성하고 사용하는 방법에 대한 지침은 JWT 흐름을 사용하여 조직의 사용자 지정 OAuth2 애플리케이션 구성 및 사용을 참조하십시오.
- PKCE를 사용하여 OAuth2 응용 프로그램을 구성하고 사용하는 방법에 대한 지침은 PKCE 흐름을 사용하여 조직의 사용자 지정 OAuth2 응용 프로그램 구성 및 사용을 참조하십시오.
액세스 요구 사항
이 문서의 단계를 수행하려면 다음 액세스 권한이 있어야 합니다.
table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
---|---|
Adobe Workfront 플랜 | 임의 |
Adobe Workfront 라이센스 |
새로운 기능: Standard 또는 현재:계획 |
액세스 수준 구성 | Workfront 관리자여야 합니다. |
이 표의 정보에 대한 자세한 내용은 Workfront 설명서의 액세스 요구 사항을 참조하십시오.
OAuth2 개요
응용 프로그램이 Workfront에서 특정 정보를 가져와야 한다고 가정해 보세요. 정보를 요청하는 애플리케이션을 클라이언트라고 합니다. 이 예에서 클라이언트 이름은 ClientApp입니다. ClientApp은 특정 사용자의 정보에 액세스해야 하므로 해당 사용자로 Workfront에 액세스해야 합니다. 사용자가 ClientApp에 사용자 이름과 암호를 제공하면 ClientApp은 사용자가 액세스할 수 있는 모든 데이터에 액세스할 수 있습니다. ClientApp에는 소량의 특정 정보만 필요하므로 이는 보안 위험이 있습니다.
ClientApp용 OAuth2 앱을 만들 때 기본적으로 Workfront에게 ClientApp이 Workfront에 액세스할 수 있다고 알려주지만, ClientApp이 액세스하는 계정의 사용자가 액세스 권한을 부여하는 경우에만 가능합니다.
OAuth2 애플리케이션 만들기
OAuth2 애플리케이션을 만들 때 통합의 요구 사항에 가장 적합한 애플리케이션 유형을 선택합니다.
서버에서 실행되는 CLI, 데몬 또는 스크립트에 적합
예:
-
Shell
-
Python
모바일 또는 단일 페이지 웹 애플리케이션에 적합
예:
-
Javascript
-
Angular
-
React
-
Vue
서버에서 자격 증명 및 토큰을 처리하는 서버측 애플리케이션에 적합
예:
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
서버 인증을 사용하여 OAuth2 애플리케이션 만들기(JWT 흐름) create-an-oauth2-application-using-server-authentication-jwt-flow
-
Adobe Workfront의 오른쪽 상단에 있는 주 메뉴 아이콘 을 클릭하거나(가능한 경우) 왼쪽 상단에 있는 주 메뉴 아이콘 을 클릭한 다음 설정 을 클릭합니다.
-
왼쪽 탐색 패널에서 시스템 을 클릭한 다음 OAuth2 응용 프로그램 을 선택합니다.
-
앱 통합 만들기 를 클릭합니다.
새 OAuth2 응용 프로그램 상자가 표시됩니다. -
새 OAuth2 응용 프로그램 상자에서 컴퓨터 대 컴퓨터 응용 프로그램 을 선택합니다.
-
새 응용 프로그램의 이름을 입력하십시오(예: "Workfront for ClientApp").
-
Click Create.
-
새 앱의 필드를 채웁니다.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header 클라이언트 ID 이 필드는 자동으로 생성됩니다. 클라이언트 암호 이 필드는 자동으로 생성됩니다.
중요:
이 페이지를 닫기 전에 이 필드의 내용을 다른 보안 파일에 복사합니다. 이 비밀 키를 다시 볼 수 없습니다.
이 키를 분실하면 삭제하고 클라이언트 암호를 만드십시오.
-
현재 클라이언트 암호를 삭제하려면 Delete 아이콘 을(를) 클릭하십시오.
-
새 클라이언트 암호를 생성하려면 클라이언트 암호 추가 를 클릭하십시오.
공개 키 서버 간 앱은 인증을 위해 공개 및 개인 키를 사용합니다. 다음 중 하나를 수행하십시오.
-
공개 키 추가 를 클릭하고 다른 응용 프로그램의 공개 키를 입력합니다.
-
공개/개인 키 쌍 생성 을(를) 클릭한 다음 다른 응용 프로그램과 공개 키를 공유합니다.
이름 앱에 지정한 이름과 동일한 이름입니다. 이 필드는 비워 둘 수 없습니다. 설명 통합에 대한 설명을 입력합니다. -
-
저장 을 클릭합니다.
사용자 자격 증명(인증 코드 흐름)과 함께 OAuth2 애플리케이션을 구성하고 사용하는 방법에 대한 지침은 JWT 흐름을 사용하여 조직의 사용자 지정 OAuth2 애플리케이션 구성 및 사용을 참조하십시오.
사용자 자격 증명을 사용하여 OAuth2 애플리케이션 만들기(인증 코드 흐름) create-an-oauth2-application-using-user-credentials-authorization-code-flow
https://app.workfrontfusion.com/oauth/cb/workfront-workfront
https://app-eu.workfrontfusion.com/oauth/cb/workfront-workfront
(EU 데이터 센터)https://app-az.workfrontfusion.com/oauth/cb/workfront-workfront
(Azure 데이터 센터)
-
Adobe Workfront의 오른쪽 상단에 있는 주 메뉴 아이콘 을 클릭하거나(가능한 경우) 왼쪽 상단에 있는 주 메뉴 아이콘 을 클릭한 다음 설정 을 클릭합니다.
-
왼쪽 탐색 패널에서 시스템 을 클릭한 다음 OAuth2 응용 프로그램 을 선택합니다.
-
앱 통합 만들기 를 클릭합니다.
새 OAuth2 응용 프로그램 이 표시됩니다.
-
새 OAuth2 응용 프로그램 상자에서 웹 응용 프로그램 을 선택합니다.
-
새 OAuth2 응용 프로그램의 이름을 입력하십시오(예: "Workfront for ClientApp").
-
Click Create.
-
새 앱의 필드를 채웁니다.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 layout-auto html-authored no-header 클라이언트 ID 이 필드는 자동으로 생성됩니다. 클라이언트 암호 이 필드는 자동으로 생성됩니다.
중요:
이 페이지를 닫기 전에 이 필드의 내용을 다른 보안 파일에 복사합니다. 이 비밀 키를 다시 볼 수 없습니다.
이 키를 분실하면 삭제하고 클라이언트 암호를 만드십시오.
-
현재 클라이언트 암호를 삭제하려면 Delete 아이콘 을(를) 클릭하십시오.
-
새 클라이언트 암호를 생성하려면 클라이언트 암호 추가 를 클릭하십시오.
리디렉션 URL 사용자가 Workfront (으)로 인증되면 이 경로로 리디렉션됩니다. 새로 고침 토큰 순환 새로 고침 토큰을 사용할 때마다 새 새로 고침 토큰을 발급하려면 이 옵션을 활성화합니다. 애플리케이션은 매번 새로 고침 후에 새 새로 고침 토큰을 저장해야 합니다. 절대 새로 고침 토큰 만료 새로 고침 토큰이 만료되기 전에 존재할 시간을 선택합니다. 만료되면 사용자는 통합에 다시 로그인해야 합니다. 새로 고침 토큰이 만료되지 않도록 하려면 "만료 없음"을 선택합니다. 토큰 만료 새로 고침 중지 사용자가 시스템에서 활성 상태가 아닌 경우 이후 새로 고침 토큰이 만료되는 시간을 선택합니다.
예를 들어 비활성 새로 고침 토큰 만료가 6개월이고 사용자가 6개월 동안 로그인하지 않으면 절대 새로 고침 토큰 만료가 더 오래 설정될 수 있어도 새로 고침 토큰이 만료됩니다.
로고 로고를 추가하여 이 앱의 식별 가능성을 높일 수 있습니다. 이름 앱에 지정한 이름과 동일한 이름입니다. 이 필드는 비워 둘 수 없습니다. 설명 통합에 대한 설명을 입력합니다. 앱 설명 URL "정보" 페이지 또는 통합에 대한 자세한 정보가 포함된 페이지에 대한 링크일 수 있습니다. -
-
저장 을 클릭합니다.
사용자 자격 증명(인증 코드 흐름)을 사용하여 OAuth2 응용 프로그램을 구성하고 사용하는 방법에 대한 지침은 인증 코드 흐름을 사용하여 조직의 사용자 지정 OAuth2 응용 프로그램 구성 및 사용을 참조하십시오.
PKCE를 사용하여 OAuth2 단일 페이지 웹 애플리케이션 만들기 create-an-oauth2-single-page-web-application-using-pkce
-
Adobe Workfront의 오른쪽 상단에 있는 주 메뉴 아이콘 을 클릭하거나(가능한 경우) 왼쪽 상단에 있는 주 메뉴 아이콘 을 클릭한 다음 설정 을 클릭합니다.
-
왼쪽 탐색 패널에서 시스템 을 클릭한 다음 OAuth2 응용 프로그램 을 선택합니다.
-
앱 통합 만들기 를 클릭합니다.
새 OAuth2 응용 프로그램 상자가 표시됩니다.
-
새 OAuth2 응용 프로그램 상자에서 단일 페이지 웹 응용 프로그램 을 선택합니다.
-
새 OAuth2 응용 프로그램의 이름을 입력하십시오(예: ClientApp의 경우 "Workfront").
-
Click Create.
-
새 앱의 필드를 채웁니다.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 layout-auto html-authored no-header 클라이언트 ID 이 필드는 자동으로 생성됩니다. 리디렉션 URL 사용자가 Workfront으로 인증되면 이 경로로 리디렉션됩니다. 사용할 때마다 새로 고침 토큰을 회전합니다. 새로 고침 토큰을 사용할 때마다 새 새로 고침 토큰을 발급하려면 이 옵션을 활성화합니다. 애플리케이션은 매번 새로 고침 후에 새 새로 고침 토큰을 저장해야 합니다. 절대 만료 새로 고침 토큰이 만료되기 전에 존재할 시간을 선택합니다. 만료되면 사용자는 통합에 다시 로그인해야 합니다. 새로 고침 토큰이 만료되지 않도록 하려면 "만료 없음"을 선택합니다. 비활성 만료 사용자가 시스템에서 활성 상태가 아닌 경우 이후 새로 고침 토큰이 만료되는 시간을 선택합니다.
예를 들어 비활성 새로 고침 토큰 만료가 6개월이고 사용자가 6개월 동안 로그인하지 않으면 절대 새로 고침 토큰 만료가 더 오래 설정될 수 있어도 새로 고침 토큰이 만료됩니다.
로고 로고를 추가하여 이 앱의 식별 가능성을 높일 수 있습니다. 이름 앱에 지정한 이름과 동일한 이름입니다. 이 필드는 비워 둘 수 없습니다. 설명 통합에 대한 설명을 입력합니다. Developer name OAuth2 애플리케이션을 설정하는 개발자의 이름입니다. 개발자 이메일 주소 OAuth2 애플리케이션을 설정하는 개발자의 이메일 주소입니다. 개인정보 처리방침 URL 조직에서 개인정보 처리방침을 저장하는 위치에 대한 링크입니다. -
저장 을 클릭합니다.
생성된 OAuth2 애플리케이션 구성 및 사용
생성된 OAuth2 애플리케이션을 추가로 구성하고 사용하려면 API 호출을 비롯한 몇 가지 기술 지식이 필요합니다.
- 사용자 자격 증명(인증 코드 흐름)을 사용하여 OAuth2 응용 프로그램을 구성하고 사용하는 방법에 대한 지침은 인증 코드 흐름을 사용하여 조직의 사용자 지정 OAuth2 응용 프로그램 구성 및 사용을 참조하십시오.
- 서버 인증(JWT 흐름)을 사용하여 OAuth2 애플리케이션을 구성하고 사용하는 방법에 대한 지침은 JWT 흐름을 사용하여 조직의 사용자 지정 OAuth2 애플리케이션 구성 및 사용을 참조하십시오.
- PKCE를 사용하여 OAuth2 응용 프로그램을 구성하고 사용하는 방법에 대한 지침은 PKCE 흐름을 사용하여 조직의 사용자 지정 OAuth2 응용 프로그램 구성 및 사용을 참조하십시오.
인증 코드 흐름에 대한 OAuth2 프로세스
인증 코드 및 액세스 토큰을 사용하여 인증 authorizing-with-an-authorization-code-and-access-token
-
ClientApp에는 Workfront의 정보가 필요하므로 Workfront API
/authorize
끝점에 요청을 보냅니다. 요청에 response_typecode
이(가) 포함되어 있습니다. 이는 요청이 인증 코드를 반환해야 함을 나타냅니다. -
Workfront을(를) 트리거하여 사용자에게 인증 프롬프트를 보냅니다. 사용자는 프롬프트에 자격 증명을 입력할 수 있으며, 이를 통해 Workfront에게 ClientApp과 통신할 수 있는 권한을 부여할 수 있습니다. 사용자가 이미 Workfront에 로그인한 경우 이 단계를 건너뛸 수 있습니다.
-
Workfront API가 ClientApp에 인증 코드를 보냅니다.
-
ClientApp이 Workfront API
/token
에 다음 정보를 요청으로 보냅니다. 끝점:- 3단계에서 ClientApp으로 전송된 인증 코드입니다. 이는 사용자 권한의 특정 인스턴스를 식별합니다.
- Workfront에서 ClientApp OAuth2 앱을 설정할 때 생성된 클라이언트 암호입니다. 이를 통해 Workfront은(는) 요청이 ClientApp에서 오고 있음을 알 수 있습니다.
-
인증 코드와 클라이언트 암호가 올바른 경우 Workfront에서 ClientApp에 액세스 토큰을 보냅니다. 이 액세스 토큰은 Workfront에서 ClientApp으로 직접 전송되며 다른 사용자 또는 클라이언트 응용 프로그램에서 보거나 복사하거나 사용할 수 없습니다.
-
ClientApp이 특정 정보 요청과 함께 액세스 토큰을 Workfront에 보냅니다.
-
액세스 토큰이 올바르므로 Workfront이(가) 정보를 ClientApp으로 보냅니다.
액세스 토큰 새로 고침
보안을 위해 액세스 토큰은 짧은 시간 후에 만료됩니다. 매번 자격 증명을 입력할 필요 없이 새 액세스 토큰을 가져오려면 OAuth2에서 새로 고침 토큰을 사용합니다. 새로 고침 토큰은 클라이언트에 의해 저장됩니다.
새로 고침 토큰을 가져오는 프로세스는 인증 코드 및 액세스 토큰으로 인증 섹션에 설명된 절차와 동일합니다. 인증 코드에 대한 요청에 범위 offline_access
이(가) 포함되어 있습니다. 이는 요청이 인증 코드와 함께 요청 토큰을 반환해야 함을 나타냅니다.