Office.Auth interface

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

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

パラメーター

戻り値

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

注釈

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

要件セット: IdentityAPI 1.3

重要:

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

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

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

• Outlook イベント ベースのアクティブ化アドインでは、この API はバージョン 2111 (ビルド 14701.20000) 以降の Outlook on Windows でサポートされています。 古いビルドでアクセス トークンを取得するには、代わりに OfficeRuntime.auth.getAccessToken を 使用します。 詳細については、「 イベント ベースのアクティブ化を使用する Outlook アドインでシングル サインオン (SSO) を有効にする」を参照してください。

例

try{
    const accessToken = await Office.auth.getAccessToken({
        allowSignInPrompt: true,
        allowConsentPrompt: true,
        forMSGraphAccess: true,
    });
} catch (error) {
    console.log("Error obtaining token", error);
}

Azure Active Directory V 2.0 のエンドポイントを呼び出して、アドインの Web アプリケーションへのアクセス トークンを取得します。 アドインがユーザーを識別できるようにします。 サーバー側コードでは、このトークンを使用して、"代理" OAuth フローを使用して、アドインの Web アプリケーションの Microsoft Graph にアクセスできます。

重要: Outlook では、アドインが Outlook.com または Gmail メールボックスに読み込まれている場合、この API はサポートされません。

警告: getAccessTokenAsync は非推奨になりました。 代わりに Office.auth.getAccessToken を使用します。

getAccessTokenAsync(options?: AuthOptions, callback?: (result: AsyncResult<string>) => void): void;

パラメーター

戻り値

注釈

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

要件セット: IdentityAPI 1.3

この API では、アドインを Azure アプリケーションにブリッジするシングル サインオン構成が必要です。 Office ユーザーは、組織アカウントと Microsoft アカウントを使用してサインインします。 Microsoft Azure では、Microsoft Graph のリソースにアクセスするために、両方のユーザー アカウントの種類を対象にしたトークンを返します。

例

Office.context.auth.getAccessTokenAsync(function(result) {
    if (result.status === Office.AsyncResultStatus.Succeeded) {
        const token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

Azure Active Directory V 2.0 のエンドポイントを呼び出して、アドインの Web アプリケーションへのアクセス トークンを取得します。 アドインがユーザーを識別できるようにします。 サーバー側コードでは、このトークンを使用して、"代理" OAuth フローを使用して、アドインの Web アプリケーションの Microsoft Graph にアクセスできます。

重要: Outlook では、アドインが Outlook.com または Gmail メールボックスに読み込まれている場合、この API はサポートされません。

警告: getAccessTokenAsync は非推奨になりました。 代わりに Office.auth.getAccessToken を使用します。

getAccessTokenAsync(callback?: (result: AsyncResult<string>) => void): void;

パラメーター

戻り値

注釈

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

要件セット: IdentityAPI 1.3

この API では、アドインを Azure アプリケーションにブリッジするシングル サインオン構成が必要です。 Office ユーザーは、組織アカウントと Microsoft アカウントを使用してサインインします。 Microsoft Azure では、Microsoft Graph のリソースにアクセスするために、両方のユーザー アカウントの種類を対象にしたトークンを返します。