送信リンクを設定する
外部アプリケーションへの送信リンクを設定すると、Jira はこのアプリケーションからデータをリクエストします。つまり、Jira は OAuth クライアントとして機能します。このタイプのリンクは、一般的なメール サーバーに OAuth 2.0 統合を作成するために、主に Jira で使用されます。リンクのタイプとその他の詳細については「他のアプリケーションにリンクする」をご確認ください。
SMTP 送信メール サーバー向けの OAuth 2.0 は、Jira 9.2 以降でサポートされています。
プロバイダーとしての Google と Microsoft に対するサポートと、接続用の IMAP、POP3、SMTP プロトコルに対するサポートは、Jira バージョン 8.22 ～ 9.1 まで維持されます。
使用するべきタイミング
送信 OAuth 2.0 統合が用意されている主な理由は、Google と Microsoft が基本認証の廃止を発表したためです。つまり、基本認証を使用して認証する場合は、こうしたプロバイダー (Gmail、Microsoft Exchange Online) によってユーザーがメールから課題やコメントを作成できるようにできません。これを修正するには、こうしたプロバイダーとの OAuth 2.0 統合を設定して、メール サーバーの設定を更新する必要があります。
IMAP または POP3 を使用している場合は、引き続き機能するための操作は不要です。
はじめる前に
以下を確認する必要があります。
サーバーは HTTPS 上で実行している必要があります。そうでない場合は、OAuth 2.0 を設定できません。
ベース URL が正しく設定されている必要があります。提供が必要となるリダイレクト URL は Jira のベース URL に基づくため、これは重要です。
アプリケーション リンクによって送信リンクを作成する
送信リンクを作成するには、次の手順に従います。
- 画面右上で [管理
] > [アプリ] の順に選択します。
- [統合] (左側のパネル) で、[アプリケーション リンク] を選択します。
[リンクを作成] を選択します。
開いた新しいダイアログで、[外部アプリケーション] と方向として [送信] を選択します。
次のセクションの説明に従って詳細を入力します。
送信リンクを設定する
リンクを設定するには、次の手順に従います。
1. OAuth 2.0 許可の種類を選択
Jira は次の種類の OAuth 2.0 許可をサポートしています。
- 認可コード — 個別ユーザー認証に使用され、Jira がユーザーに代わって外部アプリケーションでユーザーのリソースにアクセスできるようにします。
- クライアント認証情報 — アプリ間の通信に使用され、Jira が外部アプリケーション内で許可されているリソースに、個別のユーザー認証を介さずにアクセスできるようにします。
2. サービス プロバイダーを選択する
設定するプロバイダーを次の中から 1 つ選択します。Google または Microsoft を選択すると、メール サーバーの OAuth 2.0 統合を作成できます。この場合、一部のフィールドは事前入力されます。
Google (認可コードのみ)
Microsoft
カスタム (内部ツールまたは他のプロバイダー)
3. 許可タイプとして認可コードを選択した場合は、リダイレクト URL をコピーして外部アプリケーションに登録します
リダイレクト URL をコピーして外部アプリケーションに登録し、設定を完了するために必要なクライアント ID とクライアント シークレットを取得します。
Google または Microsoft をサービス プロバイダーとして使用している場合は、リダイレクト URL をすぐにコピーできます。カスタム プロバイダーの場合は、まず認証エンドポイントとトークン エンドポイントを入力する必要があります。Google または Microsoft で URL を登録する方法の詳細については、次のガイドをご確認ください。
プロバイダーが異なると、リダイレクト URL に関する要件も異なる場合があります。たとえば、Google ではプライベート IP アドレスにはできません。外部 URL (たとえば Jira Data Center のロード バランサーの URL など) を提供するようにしてください。
4. 残りのアプリケーションに関する詳細を入力する
残りの情報を入力します。ここでは、次のすべてのフィールドについて説明します。
| 名前 | 説明 |
|---|---|
クライアント ID | Jira のリダイレクト URL を登録した後に外部アプリケーションによって生成されたクライアント ID。これはアプリの公開 ID です。 |
クライアント シークレット | Jira のリダイレクト URL を登録した後に外部アプリケーションによって生成されたクライアント シークレット。これは Jira とアプリケーションの間で共有されるシークレットで、認証の安全性を保証するものです。 |
スコープ | Jira が外部アプリケーション内でできることを制御する、必須の OAuth 2.0 スコープ (権限)。メール サーバーに応じて異なるスコープを指定する必要があります。 Google の場合は、次のスコープをお勧めします: Microsoft の場合は、使用するプロトコルに応じて、常に
Google と Microsoft で利用できるスコープの詳細については、Microsoft と Google の各サイトにある詳細情報をご確認ください。 |
認可エンドポイント (認可コードのみ) | OAuth 2.0 を使用するための認証が開始する HTTPS URL。 |
トークン エンドポイント | トークンの更新リクエストが送信される HTTPS URL。OAuth 2.0 トークンには有効期限があるため、Jira は定期的にトークンを更新します。 |
リダイレクト URL (認可コードのみ) | リダイレクト URL。外部アプリケーションのクライアント ID とクライアント シークレットを取得するためにその外部アプリケーションで登録する必要があります。これによって、認証フローが Jira にリダイレクトされます。 |
5. 送信リンクを保存する
リンクを保存すると、そのリンクは他のアプリケーション リンクとともにリストに表示されます。メール サーバー、DVCS アカウント、または Jira Service Management メール チャンネルを設定する際に、このリンクを選択できるようになります。
次のステップ
Jira に組み込まれている以下の機能でリンクを使用できます。
トラブルシューティング
アプリの送信リンクの設定中に問題が発生した場合は、次の記事をご参照ください。