CData Python Connector for Gmail

Build 20.0.7745

カスタムクレデンシャル

カスタムOAuth アプリを使用して、サービスアカウントまたはユーザーアカウントで認証できます。詳しくは、OAuth 認証の使用 を参照してください。

IMAP の有効化

本製品 は、IMAP プロトコル経由でGmail と通信します。 IMAP を使用すると、すべてのクライアントデバイスで個々のコピーではなく、同じリモートデータを使用できます。以下の手順に従って、IMAP 経由のGmail へのアクセスを有効にします。

  1. Gmail Web インターフェースを開き、[設定]ボタン(歯車のアイコン)をクリックします。
  2. [Forwarding and POP/IMAP]タブで[Enable IMAP]を選択します。
  3. 変更を保存します。

ユーザーアカウントで認証する

カスタムOAuth アプリでのデスクトップ認証

下記の手順に従って、カスタムOAuth アプリの資格情報を使用して認証します。カスタムOAuth アプリの作成 を参照してください。

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

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

  • OAuthClientId:アプリの登録時に割り当てられたクライアントID に設定。
  • OAuthClientSecret:アプリの登録時に割り当てられたクライアントシークレットに設定。
  • InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
  • User:Gmail アカウントのユーザーに設定。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 本製品 はこれでOAuth プロセスを完了します。
  1. コールバックURL からアクセストークンを取得し、リクエストを認証します。
  2. アクセストークンの期限が切れたときにはリフレッシュしてください。
  3. OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。

カスタムOAuth アプリでのWeb 認証

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

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

次の接続プロパティを設定し、OAuthAccessToken を取得します。

  • OAuthClientId:アプリケーション設定のクライアントID に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。

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

  1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
  2. ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
  3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。

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

InitiateOAuth をREFRESH に設定してOAuth アクセストークンの期限が切れたときに自動的にリフレッシュするか、RefreshOAuthAccessToken ストアドプロシージャを呼び出してトークンを手動でリフレッシュできます。

自動リフレッシュ

InitiateOAuth でトークンをリフレッシュするには、最初のデータ接続で次のように設定します。

  • OAuthAccessToken:これをGetOAuthAccessToken によって返されたアクセストークンに設定します。
  • InitiateOAuth:REFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
  • OAuthSettingsLocation:本製品 がOAuth 値を保存する場所のパスを設定し、接続の間に維持されるようにします。
  • OAuthClientId:アプリケーション設定のクライアントID に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
  • OAuthRefreshToken:これをGetOAuthAccessToken によって返されたリフレッシュトークンに設定します。
  • User:Gmail アカウントのユーザーに設定。

その後のデータ接続では、次を設定します。

  • InitiateOAuth
  • OAuthSettingsLocation
  • User:Gmail アカウントのユーザーに設定。

手動でリフレッシュ

RefreshOAuthAccessToken ストアドプロシージャを使用してOAuthAccessToken を手動でリフレッシュできます。GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後にストアドプロシージャを呼び出します。以下の接続プロパティが設定されている必要があります。

  • OAuthClientId:アプリケーション設定のクライアントID に設定。
  • OAuthClientSecret:アプリケーション設定のクライアントシークレットに設定。
  • User:Gmail アカウントのユーザーに設定。

次のパラメータセットを使用してRefreshOAuthAccessToken を呼び出すことができます。

  • OAuthRefreshToken:これをGetOAuthAccessToken によって返されたOAuthRefreshToken に設定します。

サービスアカウントで認証する

サービスアカウントには、ブラウザによるユーザー認証なしのサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープを本製品 に委任することもできます。

このフローでは、OAuth アプリケーションを作成する必要があります。アプリの作成および認可については、カスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるGmail データに接続できます。

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

  • InitiateOAuth:GETANDREFRESH に設定。
  • OAuthJWTCertType:"PFXFILE" に設定。
  • OAuthJWTCert:生成した.p12ファイルのパスに設定。
  • OAuthJWTCertPassword:.p12ファイルのパスワードに設定。
  • OAuthJWTCertSubject:"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
  • OAuthJWTSubject:アクセスの委譲を要求しているアプリケーションのユーザーのE メールアドレスを設定。管理者がアクセス委譲を承認しなければならないので、ご注意ください。
  • User:接続するGmail アカウントのユーザーに設定。
接続すると、本製品 はサービスアカウントでのOAuth フローを完了します。
  1. 本製品 に要求されるclaim set でJWT を作成し、サインします。
  2. JWT はアクセストークンと交換されます。
  3. OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。
  4. トークンの期限が切れたときは、JWT を送り、新しいアクセストークンと交換します。

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 20.0.7745