CData PowerShell Cmdlets for Okta はじめに:インストールから接続まで
このガイドでは、Okta PowerShell Cmdlets の使い方を詳しく解説します。Cmdlet のインストール、初回接続の設定、クエリの実行、そして PowerShell で Okta のデータ を操作するための次のステップをご紹介します。
インストールとライセンス認証
システム要件
CData PowerShell Cmdlets は、PowerShell が動作するあらゆる環境で実行できます。
Windows
- Windows 10/11
- Windows Server 2016 以降
- PowerShell 5.1 または PowerShell 7 以降
macOS / Linux
- PowerShell 7 以降
- 追加のシステムライブラリは不要
- アーキテクチャ固有のインストーラーは不要
Cmdlet のインストール
CData Cmdlets は PowerShell Gallery から配布されており、プラットフォーム間で簡単かつ一貫したインストールプロセスを実現しています。
インストール手順
- 管理者モードで PowerShell を開きます
- 以下のコマンドを実行して Cmdlet モジュールをインストールします:
Install-Module OktaCmdlets -Repository PSGallery -Force
このコマンドは:
- 公式の PowerShell Gallery からモジュールをダウンロードします
- PowerShell 環境にインストールします
- すべての Cmdlet をすぐに使用できるように登録します
モジュールの確認
インストールを確認するには:
Get-Module -ListAvailable "*Okta*"
ライセンス認証
Cmdlets は試用版と正規ライセンスの両方の認証に対応しています。
試用版ライセンス
試用版の認証は自動的に行われ、キーは不要です。インストール後すぐに Cmdlet を使用できます。
正規ライセンスの認証
正規ライセンスを購入された場合、CData Orders チームからプロダクトキーを受け取ります。
ライセンスの認証
以下のコマンドを実行します:
Set-ModuleLicense ""
認証が成功すると、確認メッセージが表示されます。
ライセンスに関するよくある質問
ライセンスは複数のマシンで使用できますか?
サブスクリプションプランによります。注文確認メールを確認するか、[email protected] までお問い合わせください。
ライセンスキーを紛失しました。どうすればよいですか?
注文番号を添えて [email protected] までメールでお問い合わせください。
ライセンスを別のマシンに移行できますか?
以下のリンクからライセンス移行リクエストを送信してください:https://www.cdata.com/lic/transfer/
ライセンスはどこで管理できますか?
CData カスタマーポータルにアクセスしてください:https://portal.cdata.com/
接続設定
モジュールがインストールされ、ライセンスが認証されたら、
Connect-Okta cmdletを使用して Okta への接続を確立できます。
必要な接続プロパティを取得したら、PowerShell で Okta のデータ にアクセスしてレプリケーションを準備するには、基本的に 4 つのステップがあります。
Okta に接続するには、Domain 接続文字列プロパティをお使いのOkta ドメインに設定します。 Okta はOAuth およびOAuthJWT 認証をサポートしています。
OAuth認証
OAuth で認証するには、AuthScheme をOAuth に設定する必要があります。また、カスタムOAuth アプリケーションを作成する必要があります。
カスタムOAuth アプリケーションの作成
Okta アカウントから:
- 管理者アカウントでOkta のデベロッパーエディションにサインインします。
- Admin Consoleで、Applications > Applications に移動します。
- Create App Integration をクリックします。
- Sign-in method は、OIDC - OpenID Connect を選択します。
- Application type は、Web Application を選択します。
- カスタムアプリケーションの名前を入力します。
- Grant TypeをAuthorization Code に設定します。トークンを自動的に更新したい場合は、Refresh Token もチェックしてください。
- コールバックURL を設定します。
- デスクトップアプリケーションやヘッドレスマシンでは、http://localhost:33333 または任意の別のポート番号を使用します。ここで設定したURI が、CallbackURL プロパティになります。
- Web アプリケーションの場合、コールバックURL を信頼できるリダイレクトURL に設定します。このURL は、アプリケーションへのアクセスが許可されたことを示すトークンを伴ってユーザーが戻ってくるWeb 上の場所です。
- Assignments セクションで、Limit access to selected groups を選択してグループを追加するか、グループの割り当ては一旦スキップします。
- OAuth アプリケーションを保存します。
- アプリケーションのGeneral タブに、アプリケーションのClient Id とClient Secret が表示されます。後で使用できるように、これらを記録してください。Client Id はOAuthClientId の設定に使用し、Client Secret はOAuthClientSecret の設定に使用します。
- Assignments タブを確認し、アプリケーションにアクセスする必要のあるすべてのユーザーがアプリケーションに割り当てられていることを確かめます。
- Okta API Scopes タブで、OAuth アプリケーションに付与するスコープを選択します。これらのスコープは、アプリが読み取り可能なデータを決定します。そのため、特定のビューに対するスコープを付与しないと、そのビューに対するクエリを実行する権限がドライバーに付与されません。各ビューに必要なスコープを確認するには、ヘルプドキュメントのデータモデル > ビュー のビュー固有のページを参照してください。
OAuth 認証の詳細や、OAuthJWT 認証については、ヘルプドキュメントを参照してください。
Okta のデータ の取得
-
モジュールをインストールします:
Install-Module OktaCmdlets
-
Okta に接続します:
$okta = Connect-Okta -Domain $Domain
PowerShell での Okta のデータ のクエリ
接続後、標準 SQL のようなコマンドを使用してデータをクエリできます。
クエリ例:
$results = Select-Okta `
-Connection $conn `
-Table "Users" `
-Columns "Id,ProfileFirstName" `
-Where "Id != ''"
結果を表示します:
$results
これで PowerShell から Okta のデータ にアクセスできるようになりました。
よくある問題
認証エラー
解決策: ユーザー名、パスワード、セキュリティトークンを確認してください。OAuth アプリケーションの場合、アプリケーションのセキュリティ設定で CData を認可する必要がある場合があります。認可のサポートについては [email protected] までお問い合わせください。
ネットワークまたはプロキシの問題
解決策: ファイアウォール設定とアウトバウンドアクセスを確認してください。ほとんどのクラウドアプリケーションはポート 443 を使用します。
Cmdlet が見つからない
解決策: モジュールがインストールされていることを確認してください -
Get-Module -ListAvailable "*Okta*"
クエリが遅い
解決策:
- フィルターを追加してデータセットのサイズを削減してください
- サポートされている場合は $Limit または $Top プロパティを使用してください
- 最適化のサポートについては [email protected] までお問い合わせください
接続に関するその他のトラブルシューティングについては、具体的なエラーメッセージを添えて [email protected] までお問い合わせください。
次のステップ
PowerShell Cmdlets のインストール、ライセンス認証、接続設定が完了しました。以下のシナリオを参考に、さらに活用してみてください:
| PowerShell | 記事タイトル |
|---|---|
| Piping Cmdlets | PowerShell で Okta のデータ を CSV にパイプする方法 |
| Replication | PowerShell スクリプトで Okta のデータ を MySQL にレプリケートする |
サポート
ご不明な点がございましたら、お気軽にお問い合わせください:
- テクニカルサポート: [email protected]
- コミュニティフォーラム: CData Community Site
- ヘルプドキュメント: ローカルにインストールされているほか、オンラインでも参照可能です
FAQ(PowerShell Cmdlets)
インストールとライセンス
- Cmdlet のインストールには管理者権限が必要ですか?
- Windows PowerShell 5.1(Windows):管理者権限が推奨されます。特にすべてのユーザー向けにモジュールをインストールする場合に必要です。
- PowerShell 7 以降(Windows、macOS、Linux):以下のコマンドを使用することで、管理者権限なしで現在のユーザー向けに Cmdlet をインストールできます:
Install-Module OktaCmdlets -Scope CurrentUser
- インストーラーをダウンロードする必要がありますか?
必ずしも必要ではありません。
CData PowerShell Cmdlets は PowerShell Gallery から配布されています。インストールは以下のコマンドで実行します:
Install-Module OktaCmdlets -Repository PSGallery -Force
接続
- 同じデータソースの複数のアカウントに接続するにはどうすればよいですか?
異なる認証プロパティを持つ個別の接続オブジェクトを作成します:
$conn1 = Connect-Okta -User User1 -Password Pwd1
$conn2 = Connect-Okta -User User2 -Password Pwd2
Cmdlet は ODBC DSN を使用しません。すべての接続プロパティは
Connect-Oktaで直接渡されます。
多くの Cmdlet は以下のようなプロキシプロパティをサポートしています:
- ProxyServer
- ProxyPort
- ProxyUser
- ProxyPassword
データソース固有のヘルプドキュメントを参照してください。
パフォーマンスとトラブルシューティング
- クエリが遅いのはなぜですか?
- フィルターがない(WHERE 句がない)
- 大量の結果セットを取得している
- クラウド API からのレイテンシ
- 増分戦略を使用していない
- データをフィルタリングする(-Where パラメータ)
- 必要なカラムのみを選択する
- データソースの API スロットリング制限を確認する
- ログを有効にするにはどうすればよいですか?
よくある原因:
以下をお試しください:
クエリ最適化のサポートについては [email protected] までお問い合わせください。
以下のコマンドでモジュールのログを有効にします:
Set-ModuleLogging -Path "C:\logs\cdata.log" -Verbosity 3CData サポートと連携する際は、ログファイルを安全にアップロードしてください。
ほとんどのクラウドアプリケーション(Salesforce、HubSpot、Dynamics、Google API など)は HTTPS(443)を使用します。
ソースが追加のポートを必要とする場合は、固有のドキュメントを確認するか、[email protected] までお問い合わせください。
コンテナに PowerShell 7 をインストールし、モジュールをインストールします:
pwsh -Command "Install-Module OktaCmdlets -Force"その後、通常どおり認証を行います。
一般
- サポートされているすべての SQL/コマンド操作はどこで確認できますか?
- PowerShell Cmdlets はどのくらいの頻度で更新されますか?
- コード例はどこで確認できますか?
- 基本的なクエリ
- Insert/Update/Delete
- OAuth フロー
- ファイル操作
- API 連携
各 Cmdlet にはローカルにインストールされたヘルプドキュメントが含まれており、オンラインでも参照可能です:https://www.cdata.com/powershell/
CData はメジャーアップデートを年次でリリースし、年間を通じて増分アップデートを行います。バージョンの入手可能性については、カスタマーポータルを確認するか、[email protected] までお問い合わせください。
すべての Cmdlet にはヘルプドキュメントに例が含まれており、多くのサービスのオンライン例も提供されています:https://www.cdata.com/powershell/ 例には以下が含まれます:
この FAQ で解決しない場合は、[email protected] までお問い合わせください。