Excel Add-In for Jira

Build 25.0.9434

カスタムOAuth アプリケーションの作成

カスタムOAuth アプリケーションの作成

ユーザー名やAPI トークンへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth 認証が使用できます。Jira はOAuth 認証標準を使用しています。これには認証ユーザーがブラウザ経由でJira と通信する必要があります。このセクションで説明するとおり、本製品 はさまざまな方法でOAuth 交換をサポートします。

NOTE： Jira Cloud はOAuth 2.0 でのみ利用可能です。

CData はOAuth アプリケーション認証情報を製品に組み込んでおり、デスクトップアプリケーションから接続する際に使用できます。

以下の場合、独自のOAuth アプリケーション認証情報を使用することもできます。

  • 認証ダイアログのブランディングをコントロールしたいとき
  • ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
  • ユーザーからのリクエストに対する許可をカスタマイズしたいとき

手順

お使いのJira cloud インスタンスのOAuth クライアントクレデンシャル、コンシューマーキーおよびコンシューマーシークレットを取得するには：

  1. Jira Cloud サイトにログインします。
  2. アプリケーションの管理https://developer.atlassian.com/apps/ に移動します（自己ホスト型ツール用のyoursitename.atlassian.net/secure/admin/oauth-credentials にあるOAuth クレデンシャルではありません）。
  3. Create new app を選択してアプリケーションに名前を付けます。アプリケーションが作成されます。
  4. アプリケーションにOAuth 2.0 機能がない場合は、APIS AND FEATURES -> + Add -> Add OAuth 2.0 (3LO) に移動して追加します。
  5. APIS AND FEATURES -> + Add から、Jira platform REST API をアプリケーションに追加します。
  6. APIS AND FEATURES -> + Jira platform REST API から、目的のスコープをアプリケーションに追加します。
  7. さらに、コールバックURL を設定する必要があります。APIS AND FEATURES -> OAuth 2.0 (3LO) に移動します。アプリケーションにアクセス可能なURL を入力して変更を保存します。

お使いのJira Data Center インスタンスのコンシューマーキーおよびコンシューマーシークレットを含むOAuth クライアントクレデンシャルを取得するには：

  1. Jira Data Center サイトにログインします。
  2. Administration -> Applications -> Application Links に進みます。
  3. Create Link をクリックします。
  4. External Application を選択し、direction としてIncoming を選択します。
  5. Application Name フィールドおよびRedirect URL フィールド（例：http://localhost:33333）を入力します。
  6. Permissions を設定します。推奨されるアクセス許可：READ、WRITE、ADMIN。
  7. 作成されたアプリを保存します。
  8. アプリの詳細で、生成されたClient ID およびClient Secret を確認できます。

デスクトップアプリケーション

次の接続プロパティを設定して、接続してください。

  • OAuthClientId：アプリケーションの詳細のコンシューマーキーに設定。
  • OAuthClientSecret：アプリケーションの詳細のコンシューマーシークレットに設定。
  • CallbackURL：アプリで設定したコールバックURL に設定します。
    • Cloud バージョンでは、APIS AND FEATURES -> OAuth 2.0 (3LO) 下のアプリケーションの詳細で確認できます。
    • Data Center バージョンでは、Administration -> Applications -> Application Links -> Edit 下のアプリケーションの詳細で確認できます。
  • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使って、OAuth 交換や、手動でのOAuthAccessToken 接続プロパティの設定の繰り返しを避けられます。
  • OAuthVersion：2.0 に設定。
  • URL：Jira エンドポイントへのURL。例えば、https://yoursitename.atlassian.net です。

接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 が以下のOAuth プロセスを完了します。

  • コールバックURL でアクセストークンおよびoauthserverurl を設定し、認証リクエストを行います。
  • OAuth 値をOAuthSettingsLocation に保存します。これらの値は接続間で永続化されます。
  • 返されたリフレッシュトークンと有効なアクセストークンとを交換します。

Web アプリケーション

次の接続プロパティを設定し、アクセストークンを取得します。

  • OAuthClientId：アプリケーションの詳細のコンシューマーキーに設定。
  • OAuthClientSecret：アプリケーションの詳細のコンシューマーシークレットに設定。
  • CallbackURL：アプリで設定したコールバックURL に設定します。
    • Cloud バージョンでは、APIS AND FEATURES -> OAuth 2.0 (3LO) 下のアプリケーションの詳細で確認できます。
    • Data Center バージョンでは、Administration -> Applications -> Application Links -> Edit 下のアプリケーションの詳細で確認できます。
  • URL：Jira エンドポイントへのURL。例えば、https://yoursitename.atlassian.net です。
  • OAuthVersion：2.0 に設定。

Web アプリケーションから接続する場合、または本製品 にブラウザウィンドウを開く権限がない場合は、temporary verification value とアクセストークンを交換する必要があります。

  1. GetOAuthAuthorizationURL を呼び出します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
  2. ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。GrantType パラメータをImplicit に設定した場合、クエリ string パラメータにおいて、コールバックURL はOAuthAccessToken およびoauthserverurl を保持します。GrantType パラメータを"code に設定した場合、クエリ string パラメータ "code" において、コールバックURL はverifier code を保持します。verifier code を取り出し、GetOAuthAccessToken を呼び出します。

次の接続プロパティを設定し、データに接続します。

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434