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

OAuth 認証情報を使用すると、Bitbucket Data Center や Jenkins などの自己ホスト型の開発およびビルド ツールを Jira Cloud サイトに統合できます。つまり、開発またはリリース情報を Jira 作業項目に関連付けるためにファイアウォールを開放したり、サードパーティ アドオンをインストールしたりする必要がなくなります。

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

はじめる前に

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

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

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

1. [設定] ()、[Marketplace アプリ] の順に選択します。

2. サイドバーで [OAuth 認証情報] を選択します。

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

4. 次の詳細を入力し、[作成] を選択します。

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

   • Data Center ベース URL - 統合先のツールへの URL。Jira 作業項目からの今後のアクションで使用されます。 

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

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

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

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

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

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

1. Jira にログインして、[設定] ()、[Marketplace アプリ] の順に選択します。

2. サイドバーで [OAuth 認証情報] を選択します。

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

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

スコープ

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

OAuth 認証情報 (2LO) を使用できるのは、ビルド API、デプロイ API、開発情報 API、機能フラグ API、リモート リンク API を使用してビルド、デプロイ、開発、機能フラグの情報に関するデータを送信し、そのデータを Jira 作業項目に関連付ける場合のみです。

動作の仕組み

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

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

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

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

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

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

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

• 統合するツールには Jira Cloud への読み取りアクセスがないため、Jira データは安全に保たれます。交換されるデータは、他のツールから Jira に送信された作業関連情報のみです。