CData Python Connector for Okta

Build 24.0.9062

接続の確立

コネクタ内で利用可能なオブジェクトは、"cdata.okta" モジュールからアクセスできます。モジュールのオブジェクトを直接使用するには:

  1. モジュールを以下のようにインポートします。
    import cdata.okta as mod
  2. 接続を確立するには、以下のような適切な接続文字列を使用してコネクタオブジェクトからconnect() メソッドを呼び出します。
    mod.connect("Domain=dev-44876464.okta.com;OAuthClientId=myId;OAuthClientSecret=mySecret;InitiateOAuth=GETANDREFRESH;")

Okta への接続

Okta に接続するには以下のパラメータを設定します。

  • Domain:Okta ドメイン。

Okta への認証

Okta はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするためにカスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、3つの一般的な認証フローでのOkta への認証について詳しく説明します。

カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。

Okta で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

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

デスクトップアプリケーション経由で接続するには、OAuthアクセストークンを設定し、リフレッシュする必要があります。

OAuth アクセストークンの取得およびリフレッシュ

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

  • InitiateOAuthGETANDREFRESHOAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
  • OAuthClientId:カスタムOAuth アプリケーションを作成した際に表示されたキー。
  • OAuthClientSecret:カスタムOAuth アプリケーションを作成した際に表示されたシークレット。
  • CallbackURL:アプリケーションの登録時に定義されたCallback URL。通常はhttp://localhost:33333 に設定します。

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

アプリケーションにアクセス許可を与えると、本製品 はOAuth プロセスを完了します。

  1. 本製品 はOkta からアクセストークンを取得し、それを使ってデータをリクエストします。
  2. OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます。

アクセストークンの期限が切れたときは、本製品 は自動でアクセストークンをリフレッシュします。

Web アプリケーション

Web 経由で認証する場合は、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成および登録する必要があります。 それから本製品 を使用してOAuth トークンの値を取得および管理します。

このセクションでは、OAuth アクセストークンの取得方法、ドライバーにOAuth アクセストークンを自動的に更新させる方法、OAuth アクセストークンを手動で更新する方法について説明します。

OAuth アクセストークンの取得:

  1. OAuthAccessToken を取得するには、次の接続プロパティを設定します。
    • OAuthClientId:カスタムOAuth アプリケーションを作成した際に表示されたキー。
    • OAuthClientSecret:カスタムOAuth アプリケーションを作成した際に表示されたシークレット。

      AuthSchemecodeclient のどちらに設定されているかによって、認証は認可コードまたはクライアントクレデンシャルグラントタイプのいずれかで実行されます。

  2. ストアドプロシージャを呼び出し、OAuth 交換を完了します。

    1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL をカスタムOAuth アプリを作成する際に指定したコールバックURL に設定します。 ストアドプロシージャは、OAuth エンドポイントへのURL を返します。
    2. ステップ1でストアドプロシージャが返したURL に移動します。 ログインしてWeb アプリケーションを認可します。 コールバックURL にリダイレクトされ、ブラウザにURL として表示されます。
    3. GetOAuthAccessToken ストアドプロシージャを呼び出します。 AuthMode インプットをWEB に設定します。 Verifier インプットを、コールバックURL のcode パラメータに設定します。

アクセストークンとリフレッシュトークンを取得したのち、データに接続してOAuth アクセストークンを自動的にリフレッシュできます。

OAuth アクセストークンの自動リフレッシュ

本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには:

  1. はじめてデータに接続する前に、次の接続パラメータを設定します。

    • InitiateOAuthREFRESH
    • OAuthClientId:カスタムOAuth アプリケーションを作成した際に表示されたキー。
    • OAuthClientSecret:カスタムOAuth アプリケーションを作成した際に表示されたシークレット。
    • OAuthAccessTokenGetOAuthAccessToken によって返されたアクセストークン。
    • OAuthSettingsLocation:本製品 がOAuth 値を保存する場所のパス。これは接続間で維持されます。

  2. その後のデータ接続では、以下を設定します。

    • InitiateOAuth
    • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ:

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

  1. ExpiresIn 期間(GetOAuthAccessToken が返す)が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
  2. 次の接続プロパティを設定します。

    • OAuthClientId:カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret:カスタムOAuth アプリケーション設定のクライアントシークレット。

  3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
  4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

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

Note: AuthSchemecodeclient のどちらに設定されているかによって、認証は認可コードまたはクライアントクレデンシャルグラントタイプのいずれかで実行されます。

以下のいずれかの方法で行います。

  • オプション1:OAuthVerifier 値を取得します。
  • オプション2:インターネットブラウザに対応したマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。

オプション1またはオプション2を実行後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

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

Verifier コードを取得するには、次のようにOAuth Authorization URL で認証する必要があります。

  1. インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得します。

    次のプロパティを設定します。

    • InitiateOAuthOFF
    • OAuthClientId:カスタムOAuth アプリケーションを作成した際に表示されたキー。
    • OAuthClientSecret:カスタムOAuth アプリケーションを作成した際に表示されたシークレット。

  2. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。 ストアドプロシージャは、カスタムOAuth アプリケーションが登録されたときに構築されたCallbackURL を返します。(カスタムOAuth アプリケーションの作成 を参照してください。)

    このURL をコピーして、新しいブラウザのタブに貼り付けます。

  3. ログインして、本製品 にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。

  4. OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。

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

    • InitiateOAuthREFRESH
    • OAuthVerifier:verifier code(コールバックURL のcode パラメータの値)。
    • OAuthClientId:カスタムOAuth アプリケーションを作成した際に表示されたキー。
    • OAuthClientSecret:カスタムOAuth アプリケーションを作成した際に表示されたシークレット。
    • OAuthSettingsLocation:暗号化されたOAuth 認証値を指定された場所に永続化。

  5. 接続をテストしてOAuth 設定ファイルを生成します。

  6. これらのプロパティを再設定すると、接続の準備が整います。

    • InitiateOAuthREFRESH
    • OAuthClientId:カスタムOAuth アプリケーションを作成した際に表示されたキー。
    • OAuthClientSecret:カスタムOAuth アプリケーションを作成した際に表示されたシークレット。
    • OAuthSettingsLocation:暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品 に読み書きのアクセス許可を与えることを確認してください。

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

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

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

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

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

  • InitiateOAuthREFRESH
  • OAuthClientId:カスタムOAuth アプリケーションを作成した際に表示されたシークレット。
  • OAuthSettingsLocation:ブラウザでマシンからコピーしたOAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品 に読み書きのアクセス許可を与えることを確認してください。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062