CData Python Connector for REST

Build 25.0.9440

GetOAuthAccessToken

REST へのAPI コールの認証および認可に使用されるOAuth Access Token を取得します。

Input

Name Type Description
Other_Options String OAuth 認証の動作をカスタマイズするための追加オプション。
Cert String 認証用の個人証明書(.pfx)ファイルへのパス。OAuth 1.0 にのみ適用されます。
Cert_Password String 'Cert' で指定された個人証明書ファイルのパスワード。OAuth 1.0 にのみ適用されます。
AuthToken String アクセストークンを取得するために必要な、GetOAuthAuthorizationUrl によって返される一時的なトークン。OAuth 1.0 にのみ適用されます。
AuthKey String OAuth リクエストトークンに関連付けられたシークレットキー。GetOAuthAuthorizationUrl によって返されます。OAuth 1.0 にのみ適用されます。
AuthSecret String 'AuthKey' のレガシーエイリアスで、後方互換性のために含まれています。
Sign_Method String OAuth 1.0 認証のための署名を生成する際に使用される方法を指定します。

The allowed values are HMAC-SHA1, PLAINTEXT.

The default value is HMAC-SHA1.

GrantType String 'authorization_code' や'client_credentials' などのOAuth 2.0 認可グラント種別を定義します。

The allowed values are CODE, PASSWORD, CLIENT, REFRESH.

Post_Data String 必要に応じてHTTP POST リクエストに含めるデータペイロード。
AuthMode String 認証モードを指定します。一般的な値には、ブラウザベースの認証用の'WEB' とアプリケーションベースの認証用の'APP' が含まれます。

The allowed values are APP, WEB.

The default value is WEB.

Verifier String ユーザーが権限を付与した後に認可サーバーから返される一度限りの検証コード。'WEB' 認証モードの場合のみ必要です。
Scope String API へのアクセスレベルを指定します。デフォルトでは、このデータプロバイダがサポートするすべてのAPI が含まれます。
CallbackURL String 認証後にOAuth 認可レスポンスが送信されるURL を定義します。
Prompt String 認証プロンプトがユーザーにどのように表示されるかを決定します。オプション:'NONE'(プロンプトなし)、'CONSENT'(常に同意画面を表示)、'SELECT_ACCOUNT'(ユーザーにアカウントを選択させるプロンプト)。
AccessType String ユーザーがオフラインの場合にアプリケーションがアクセスを必要とするかどうかを示します。オプション:'ONLINE'(ユーザーがオンラインの場合にのみアクセス可)、'OFFLINE'(ユーザーが不在の場合にトークンのリフレッシュを許可)。
State String 認可リクエストと共に送信され、レスポンスで返されるカスタム値。セッション追跡、リダイレクト処理、またはセキュリティチェックに一般的に使用されます。
PKCEVerifier String OAuth PKCE(Proof Key for Code Exchange)フローで使用されるワンタイム暗号キー。'AuthScheme=OAuthPKCE' の場合は必須です。

Result Set Columns

Name Type Description
OAuthAccessToken String API リクエストの認証に使用されるOAuth アクセストークン。
OAuthAccessTokenSecret String OAuth アクセストークンに関連付けられたシークレットキー。OAuth 1.0 認証に使用します。
OAuthRefreshToken String ユーザーの再認可を必要とせずに、新しいアクセストークンを要求するために使用できるトークン。
ExpiresIn String アクセストークンが失効するまでの時間(秒)。値が-1の場合、トークンに有効期限がないことを示します。
* String OAuth プロバイダーによって返される追加のレスポンスパラメータを取得します。

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