接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でJIRA Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module JIRACmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module JIRACmdlets;

Connect-JIRA cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-JIRA -User 'admin' -APIToken '123abc' -Url 'https://yoursitename.atlassian.net'

Jira への接続

接続するには、URL をJira のエンドポイントに設定します。例えば、https://yoursitename.atlassian.net です。

カスタムフィールドへのアクセス

デフォルトでは、本製品はシステムフィールドのみ表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields をtrue に設定します。または、本製品スキーマを拡張してカスタムフィールドへのアクセスを設定できます。カスタムフィールドを参照してください。カスタムフィールドが含まれる場合、サーバーの応答時間が著しく遅くなることがありますのでご注意ください。

Jira への認証

OAuth 2.0

Jira の"3本足の" OAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルを提供せずにデータに接続できます。

AuthScheme は、すべてのOAuth フローでOAuth に設定する必要があります。

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

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリの作成を参照してください。

以下を設定して、接続してください。

InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
OAuthClientId（カスタムアプリのみ）：登録時に割り当てられたクライアントId に設定。
OAuthClientSecret（カスタムアプリのみ）：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
CallbackURL（カスタムアプリのみ）：アプリケーションの登録時に定義されたリダイレクトURI に設定。
Url（カスタムアプリのみ）：JIRA エンドポイントへのURL に設定。例えば、https://yoursitename.atlassian.net です。
OAuthVersion（カスタムアプリのみ）：2.0 に設定。

接続すると、本製品はデフォルトブラウザでJira のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品はアクセストークンの期限が切れると自動的にリフレッシュします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

以下のオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：インターネットブラウザに対応したマシンに本製品をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
  - InitiateOAuth：OFF に設定。
  - OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
  - OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  - OAuthVersion：2.0 に設定。
  次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
ログインして、本製品にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後でOAuthVerifier 接続プロパティを設定するために必要です。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

InitiateOAuth：REFRESH に設定。
OAuthVerifier：これを、控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定します。
OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定されたファイルに永続化されます。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：暗号化されたOAuth 認証値を含むファイルに設定。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定されたパスに暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

InitiateOAuth：REFRESH に設定。
OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルへのパスに設定。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。

OAuth 1.0

Jira に接続するには、次の手順に従ってください。

RSA 公開 / 秘密キーのペアを生成します。ターミナルで次のコマンドを実行します。

-openssl genrsa -out jira_privatekey.pem 1024
-openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
-openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
-openssl x509 -pubkey -noout -in jira_publickey.cer  -out jira_publickey.pem

アカウントにアプリケーションリンクを作成します。設定 -> アプリケーション -> アプリケーションのリンクに進みます。
URL フィールドにテストURL を入力し、新しいリンクを作成をクリックします。
エラーを無視して続行をクリックします。必要なのは受信コール（アプリケーションからJira へ）の設定のみです。
Link Applications ウィンドウでは、このタスクと関連性がないため、フィールドの入力は任意です。ただし、受信リンクの作成は選択してください。続行をクリックして次のページに進みます。
必須フィールドを埋めます。
- コンシューマーキー：任意の文字列を使用。これはOAuthClientId 接続プロパティで必要です。
- コンシューマー名：任意の文字列を使用。
- パブリックキー：先に生成したjira_publickey.pem ファイルのキーを入力。
続行をクリックします。

接続するには次のプロパティを設定します。

URL （例：https://yoursitename.atlassian.net）。
OAuthClientId をアプリケーションのConsumer Key に設定。
OAuthClientSecret を任意の値（'testClientSecret' など）に設定。
CertificateStore を秘密キーファイルの場所に設定。
CertificateStoreType を使用されている秘密キーファイルに基づいて適切なオプションに設定。生成されたPEM キーファイルを使用する場合は、CertificateStoreType をPEMKEY_FILE に設定します。
InitiateOAuth をGETANDREFRESH に設定。

API トークン

AuthScheme をAPIToken に設定し、User およびAPIToken を設定することで、任意のJira Cloud アカウントへの接続を確立できます。
Cloud インスタンスへのベーシック認証には、API トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインして［セキュリティ設定］->［API トークン］->［API トークンを作成する］をクリックします。生成されたトークンが表示されます。

Basic

AuthScheme をBasic に設定することで、任意のJira Server インスタンスへの接続を確立できます。Server インスタンスに接続するには、User およびPassword を指定します。
（Note：パスワードはCloud アカウントへの接続には非推奨となり、Server インスタンスへの接続にのみ使用されるようになりました。）

LDAP

AuthScheme をLDAP に設定することで、任意のJira Server インスタンスへの接続を確立できます。追加で、Jira インスタンスのURL、User、およびPassword を指定します。（Note：LDAP 認証は現在、Cloud アカウントではサポートされていません。）

Crowd

AuthScheme をCrowd に設定します。Crowd への接続には、次の接続プロパティを使用します。

User：Crowd ユーザーアカウント。
Password：Crowd アカウントに関連付けられたパスワード。
SSOLoginURL：Crowd アカウントに関連付けられたログインURL。IDP URL は、自身のアプリケーション->［SSO］->［SSO information］->［Identity provider single sign-on URL］にあります。
SSOAppName：SSO を有効にするアプリケーションの名前。
SSOAppPassword：SSO を有効にするアプリケーションのパスワード。
SSOExchangeUrl: The URL used used to exchange the SAML token for Jira cookies. This URL may have the following formats:
- https://<authority of Jira instance>/plugins/servlet/samlconsumer
- https://<authority of Jira instance>/plugins/servlet/samlsso

次は接続文字列の例です。

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of Jira instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

Okta

AuthScheme をOkta に設定します。Okta を介した認証には、次の接続プロパティを使用します。

User：Okta ユーザーに設定。
Password：Okta パスワードに設定。
SSOLoginURL：SSO プロバイダーが使用するログインURL に設定。
SSOExchangeUrl：The URL used used to exchange the SAML token for Jira cookies. This URL may have the following formats:
- https://<authority of Jira instance>/plugins/servlet/samlconsumer
- https://<authority of Jira instance>/plugins/servlet/samlsso

以下の場合、

Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する
MFA を構成する

Okta を使用して認証するためには、SSOProperties 入力パラメータの組み合わせを使用する必要があります。それ以外の場合、これらの値を設定する必要はありません。

SSOProperties に、必要に応じて以下の入力パラメータを設定します。

APIToken：Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合、これを顧客がOkta 組織で作成したAPI Token に設定します。
MFAType：MFA フローを設定した場合に設定。現時点では、次のタイプをサポートしています：OktaVerify、Email、およびSMS。
MFAPassCode：MFA フローを設定した場合にのみ設定。これを空欄または無効な値に設定した場合、本製品はユーザーのデバイスまたはE メールにワンタイムパスワードチャレンジを発行します。パスコードを受信後、取得したワンタイムパスワードをMFAPassCode 接続プロパティに設定する接続を再度開きます。
MFARememberDevice：Okta は、MFA が必要な場合にデバイスを記憶させることをサポートします。設定された認証ポリシーに従ってデバイスの記憶が許可されている場合、本製品はMFA 認証の有効期間を延長するデバイストークンを送信します。このプロパティはデフォルトでTrue に設定されてます。MFA を記憶させない場合のみFalse に設定してください。

接続文字列の例：

AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of Jira instance>/plugins/servlet/samlconsumer;

データの取得

Select-JIRA cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-JIRA -Connection $conn -Table "Projects" -Columns @("Key, Name") -Where "Id='10000'"

Invoke-JIRA cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-JIRA -Connection $conn -Table Projects -Where "Id = '10000'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myProjectsData.csv -NoTypeInformation

Select-JIRA からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-JIRA -User 'admin' -APIToken '123abc' -Url 'https://yoursitename.atlassian.net'
PS C:\> $row = Select-JIRA -Connection $conn -Table "Projects" -Columns (Key, Name) -Where "Id = '10000'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Projects",
  "Columns":  [

  ],
  "Key":  "MyKey",
  "Name":  "MyName"
}

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-JIRA -Connection $conn -Table Projects -Where "Id = '10000'" | Remove-JIRA

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをJira にロードします。

Import-Csv -Path C:\MyProjectsUpdates.csv | %{
  $record = Select-JIRA -Connection $conn -Table Projects -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-JIRA -Connection $conn -Table Projects -Columns @("Key","Name") -Values @($_.Key, $_.Name) -Where "Id  = `'$_.Id`'"
  }else{
    Add-JIRA -Connection $conn -Table Projects -Columns @("Key","Name") -Values @($_.Key, $_.Name)
  }
}

Cmdlets for Jira