OAuth を使用した自己ホスト型ツールとの連携
注意:
- このページの情報は、Jira Software Cloud とオンプレミス / サーバー ツールの連携のみを目的にしています。 CI / CD パイプラインにクラウドベースのツールを使用している場合、こちらのページを参照するか、Atlassian Marketplace を確認してください。
- 現在、この機能はベータ版です。アトラシアンではこの機能の改善に引き続き取り組んでいます。
OAuth 認証情報を使用すると、Bitbucket Server や Jenkins などの自己ホスト型の開発およびビルド ツールを Jira Software Cloud サイトに連携できます。つまり、開発またはリリース情報を Jira 課題に関連付けるためにファイアウォールを開放したり、サードパーティ アドオンをインストールしたりする必要がなくなります。
これはシステム間の連携であり、Jira ユーザーに関連付けられるわけではありません。つまり、ユーザーベースへの変更にかかわらず、引き続き機能します。
今後このメカニズムで、Bitbucket Server や GitHub Enterprise からの開発情報など、より多くのデータ タイプをサポートすることを予定しています。
はじめる前に
Jira Cloud のサイト管理者かつ連携先のツールの管理者である必要があります。
Jira Cloud で OAuth 認証情報を作成する
OAuth 認証情報を作成するには、次の手順に従います。
> [アプリ] の順に選択します。サイドバーで [OAuth 認証情報] を選択します。
[認証情報の作成] を選択します。
以下の詳細を入力してください。
アプリ名 - ツールの名前。これが認証情報のリストに表示されます。
サーバー ベース URL - 統合先のツールへの URL。Jira 課題ビューからの今後のアクションで使用されます。
ロゴ URL - ツールのロゴへの URL。認証情報のリストでアイコンとして使用されます。
権限 - アプリが DevOps 関連の API を呼び出すために持っている権限。
[作成] を選択します。
OAuth 認証情報には、クライアント ID とクライアント シークレットが含まれます。
スコープ
作成する各 OAuth 資格情報 (2 LO) は、特定のスコープ セット、または Jira にリクエストを送信する際に使用できる API と紐付けられています。
この機能はベータ版であるため、現時点ではスコープは非常に制限されています。OAuth 認証情報 (2 LO) を使用した場合、ビルドおよびデプロイ情報に関するデータを送信し、Builds API および Deployments API を使用してそれらを Jira 課題に関連付けることのみが可能です。
今後のスコープ
Feature Flag API - 機能フラグ データを送信し、それらを Jira 課題に関連付けます。
動作の仕組み
Jira で OAuth 認証情報を作成したら、それを連携先のツールにコピーする必要があります。
大まかに言うと、これは以下のように動作します。
- Jira でツール用の OAuth 認証情報を作成します。
- 連携先のツールにそれらの認証情報をコピーします。
- 認証情報はプラグインまたはスクリプトで参照されている必要があります。これにより、Jira 関連のデータの Jira への返送がトリガーされます。
OAuth を使用することには、以下のような利点があります。
- 連携先のツールは Jira Cloud インスタンスの完全な制御権を持たないため、Jira インスタンスを安全に保てます。
- 連携先のツールには Jira Cloud への読み取りアクセスがないため、Jira データを安全に保てます。交換されるデータは、他のツールから Jira に送信された課題関連情報のみです。