OAuth を使用した自己ホスト型ツールとの連携

OAuth credentials allow you to integrate your Jira Cloud site with self-hosted development and build tools like Bitbucket Data Center and Jenkins. This means you won’t need to open your firewall or install a third-party add-on to associate development or release information with Jira work items.

これはシステム間の連携であり、Jira ユーザーに関連付けられるわけではありません。つまり、ユーザーベースへの変更にかかわらず、引き続き機能します。

はじめる前に

Jira Cloud のサイト管理者かつ連携先のツールの管理者である必要があります。

Jira Cloud で OAuth 認証情報を作成する

OAuth 認証情報を作成するには、次の手順に従います。

1. Select Settings () > Apps.

2. From the sidebar, select OAuth credentials.

3. [認証情報の作成] を選択します。

4. 次の詳細を入力し、[作成] をクリックします。

   • アプリ名 - ツールの名前。これが認証情報リストに表示されます。

   • Data Center base URL -  A URL to the tool you're integrating with, used for future actions from the Jira work item. 

   • ロゴ URL - ツールのロゴへの URL。認証情報リストでアイコンとして使用されます。

   • 権限 - アプリが API 関連の DevOps を呼び出すために持っている権限。

OAuth 認証情報には、クライアント ID とクライアント シークレットが含まれます。

OAuth 認証情報の権限を更新する

ツールの権限を追加または削除して、OAuth 認証情報の権限を更新できます。新しい権限を追加すると、その権限によって生成される種類のデータ (デプロイ情報など) の送信を開始するためのアクセス権がツールに付与されます。権限を削除すると、その権限によって付与される種類のデータを送信するためのアクセス権がツールから取り消されます。

OAuth 認証情報を更新するには、次の手順に従います。

1. Log in to Jira select Settings () > Apps.

2. From the sidebar, select OAuth credentials.

3. [操作] にある 3 点メニューで、[権限を編集] を選択します。

4. 追加または削除する権限を更新して、[保存] を選択します。

スコープ

作成する各 OAuth 資格情報 (2 LO) は、特定のスコープ セット、または Jira にリクエストを送信する際に使用できる API と紐付けされています。

You can only use the OAuth Credentials (2LO) to send data about build, deployment, development, and feature flag information, and associate that to Jira work items using the Builds API, Deployments API, Development Information API, Feature Flags API and Remote Links API.

動作の仕組み

Jira で OAuth 認証情報を作成したら、それを連携先のツールにコピーする必要があります。

大まかに言うと、これは以下のように動作します。

1. Jira でツール用の OAuth 認証情報を作成します。

2. 連携先のツールにそれらの認証情報をコピーします。

3. 認証情報はプラグインまたはスクリプトで参照されている必要があります。これにより、Jira 関連のデータの Jira への返送がトリガーされます。

OAuth を使用することには、以下のような利点があります。

• 連携先のツールは Jira Cloud インスタンスの完全な制御権を持たないため、Jira インスタンスを安全に保てます。

• Your Jira data is secure, because the tool you integrate with doesn't have any read access to Jira Cloud. The only data that is exchanged is the work-related information that is sent from the other tool to Jira.