OfficeRuntime.Auth interface

  • リファレンス
パッケージ:
office-runtime

承認に関連する API を含むインターフェイス。

注釈

このインターフェイスのメソッドは、 Office.auth インターフェイスのメソッドと同じです。 今後新しい認証の種類が追加される場合は、インターフェイスにのみ追加 Office.auth されます。 わかりやすくするために、ドキュメント全体のコード例では を使用 Office.authします。

メソッド

getAccessToken(options)

Azure Active Directory V 2.0 のエンドポイントを呼び出して、アドインの Web アプリケーションへのアクセス トークンを取得します。 アドインがユーザーを識別できるようにします。 サーバー側コードでは、 OAuth フローの "代理" を使用して、このトークンを使用してアドインの Web アプリケーションの Microsoft Graph にアクセスできます。 この API では、アドインを Azure アプリケーションにブリッジするシングル サインオン構成が必要です。 Office ユーザーは、組織アカウントと Microsoft アカウントを使用してサインインします。 Microsoft Azure では、Microsoft Graph のリソースにアクセスするために、両方のユーザー アカウントの種類を対象にしたトークンを返します。

メソッドの詳細

getAccessToken(options)

Azure Active Directory V 2.0 のエンドポイントを呼び出して、アドインの Web アプリケーションへのアクセス トークンを取得します。 アドインがユーザーを識別できるようにします。 サーバー側コードでは、 OAuth フローの "代理" を使用して、このトークンを使用してアドインの Web アプリケーションの Microsoft Graph にアクセスできます。 この API では、アドインを Azure アプリケーションにブリッジするシングル サインオン構成が必要です。 Office ユーザーは、組織アカウントと Microsoft アカウントを使用してサインインします。 Microsoft Azure では、Microsoft Graph のリソースにアクセスするために、両方のユーザー アカウントの種類を対象にしたトークンを返します。

getAccessToken(options?: AuthOptions): Promise<string>;

パラメーター

options
OfficeRuntime.AuthOptions

オプション。 サインオン動作を AuthOptions 定義するオブジェクトを受け入れます。

戻り値

Promise<string>

アクセス トークンに対する約束。

注釈

アプリケーション: Excel、Outlook、PowerPoint、Word

重要:

  • Outlook では、Outlook.com または Gmail メールボックスにアドインを読み込む場合、この API はサポートされません。

  • Outlook on the webでは、Safari ブラウザーを使用する場合、この API はサポートされません。 これにより、エラー 13001 が発生します ("ユーザーが Office にサインインしていません")。

  • Outlook on the webでは、displayDialogAsync メソッドを使用してダイアログを開く場合は、 を呼び出すgetAccessToken前にダイアログを閉じる必要があります。