OAuthRefreshToken
元のアクセストークンが期限切れになった後に新しいアクセストークンを要求するために使用される、OAuth リフレッシュトークンを指定します。
データ型
string
デフォルト値
""
解説
現在のアクセストークンが期限切れになったときに、新しいアクセストークンを取得するためにリフレッシュトークンが使用されます。 これにより、ユーザーが再度ログインすることなく、長時間実行されるワークフローや自動化された処理において、シームレスな認証が可能になります。 このプロパティは、対話型の認証ができないヘッドレス環境、CI/CD、またはサーバーベースの環境において特に重要です。
リフレッシュトークンは通常、初回のOAuth 交換時にGetOAuthAccessToken ストアドプロシージャを呼び出すことで取得されます。 その後、このプロパティを使用してトークンの自動更新を有効にするか、手動で更新を管理したい場合はRefreshOAuthAccessToken ストアドプロシージャに渡すことができます。
InitiateOAuth がREFRESH に設定されている場合、ドライバーはこのトークンを使用して、新しいアクセストークンを自動的に取得します。 最初のリフレッシュの後、ドライバーは更新されたトークンをOAuthSettingsLocation によって定義された場所に保存し、その後の接続ではその値を使用します。
Note:OAuthRefreshToken は安全に取り扱い、信頼できる場所に保管する必要があります。 アクセストークンと同様に、リフレッシュトークンもID プロバイダーのポリシーによって、有効期限が切れたり、取り消されたりする場合があります。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。