OfficeRuntime.AuthOptions interface

パッケージ:
office-runtime

警告

この API は非推奨になりました。

Use the Office.AuthOptions interface instead.

Office が getAccessToken メソッドを使用して AAD v. 2.0 からアドインへのアクセス トークンを取得するときのユーザー エクスペリエンスのオプションを提供します。

注釈

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

使用元

例

const options: OfficeRuntime.AuthOptions = {
  allowSignInPrompt: true,
  allowConsentPrompt: true,
  forMSGraphAccess: true,
};
const accessToken = await OfficeRuntime.auth.getAccessToken(options);

プロパティ

allowConsentPrompt

Office が暗黙的に、または対話型の同意 (必要な場合) を通じてアクセス トークンを取得できるようにします。 既定値は false です。 false に設定すると、Office は暗黙的にアクセス トークンの取得を試みます。 そうしない場合、Office は説明エラーを返します。 true に設定すると、Office はアクセス トークンのサイレント取得に失敗した後に、対話型の同意 UI を表示します。 プロンプトは、AAD プロファイル スコープへの同意のみを許可します。Microsoft Graph スコープには同意しません。
allowSignInPrompt

Office が暗黙的にアクセス トークンを取得しることを許可し、同意が存在するか、ユーザーをサインインするための対話型 UI を表示します。 既定値は false です。 false に設定すると、Office は暗黙的にアクセス トークンの取得を試みます。 そうしない場合、Office は説明エラーを返します。 true に設定すると、Office はアクセス トークンのサイレント取得に失敗した後に対話型サインイン UI を表示します。
asyncContext

コールバックに渡される AsyncResult オブジェクトの asyncContext プロパティで変更されずに返される、任意の型のユーザー定義項目。
authChallenge

Microsoft Graph の対象となっているテナンシが多要素認証を必要とする場合に、Office は追加要素の入力をユーザーに求めます。 文字列値は、必要な追加要因の種類を示します。 ほとんどの場合、ユーザーのテナントが追加の要素を必要とするかどうか、または文字列の内容は開発時にはわかりません。 したがって、このオプションは、追加の係数を要求し、authChallenge オプションで使用する文字列を含むエラーを Microsoft Graph が送信した後の getAccessToken の "2 回目の試行" 呼び出しで使用されます。
forceAddAccount

ユーザーに自分の Office アカウントを追加するように (または、既に追加されている場合は切り替える) ようにプロンプトを表示します。 既定値は false です。
forceConsent

Office によりアドインの同意エクスペリエンスが表示されます。 アドインの Azure アクセス許可が変更された場合や、ユーザーの同意が取り消された場合に役立ちます。 既定値は false です。
forMSGraphAccess

アドインが Microsoft Graph にアクセスしようとしていて、ユーザー/管理者が Graph スコープに同意していない場合、Office は説明的エラーを返します。 既定値は false です。 Office は、アドインがテナント管理者によって展開されている場合にのみ、Graph スコープへの同意をサポートします。このオプションを true に設定すると、Graph アクセスが失敗した場合に Office が事前にアドインに通知します (説明エラーを返します)。

プロパティの詳細

allowConsentPrompt

Office が暗黙的に、または対話型の同意 (必要な場合) を通じてアクセス トークンを取得できるようにします。 既定値は false です。 false に設定すると、Office は暗黙的にアクセス トークンの取得を試みます。 そうしない場合、Office は説明エラーを返します。 true に設定すると、Office はアクセス トークンのサイレント取得に失敗した後に、対話型の同意 UI を表示します。 プロンプトは、AAD プロファイル スコープへの同意のみを許可します。Microsoft Graph スコープには同意しません。

allowConsentPrompt?: boolean;

プロパティ値

boolean

allowSignInPrompt

Office が暗黙的にアクセス トークンを取得しることを許可し、同意が存在するか、ユーザーをサインインするための対話型 UI を表示します。 既定値は false です。 false に設定すると、Office は暗黙的にアクセス トークンの取得を試みます。 そうしない場合、Office は説明エラーを返します。 true に設定すると、Office はアクセス トークンのサイレント取得に失敗した後に対話型サインイン UI を表示します。

allowSignInPrompt?: boolean;

プロパティ値

boolean

asyncContext

コールバックに渡される AsyncResult オブジェクトの asyncContext プロパティで変更されずに返される、任意の型のユーザー定義項目。

asyncContext?: any;

プロパティ値

any

authChallenge

Microsoft Graph の対象となっているテナンシが多要素認証を必要とする場合に、Office は追加要素の入力をユーザーに求めます。 文字列値は、必要な追加要因の種類を示します。 ほとんどの場合、ユーザーのテナントが追加の要素を必要とするかどうか、または文字列の内容は開発時にはわかりません。 したがって、このオプションは、追加の係数を要求し、authChallenge オプションで使用する文字列を含むエラーを Microsoft Graph が送信した後の getAccessToken の "2 回目の試行" 呼び出しで使用されます。

authChallenge?: string;

プロパティ値

string

forceAddAccount

警告

この API は非推奨になりました。

Use allowSignInPrompt instead.

ユーザーに自分の Office アカウントを追加するように (または、既に追加されている場合は切り替える) ようにプロンプトを表示します。 既定値は false です。

forceAddAccount?: boolean;

プロパティ値

boolean

forceConsent

警告

この API は非推奨になりました。

Use allowConsentPrompt instead.

Office によりアドインの同意エクスペリエンスが表示されます。 アドインの Azure アクセス許可が変更された場合や、ユーザーの同意が取り消された場合に役立ちます。 既定値は false です。

forceConsent?: boolean;

プロパティ値

boolean

forMSGraphAccess

アドインが Microsoft Graph にアクセスしようとしていて、ユーザー/管理者が Graph スコープに同意していない場合、Office は説明的エラーを返します。 既定値は false です。 Office は、アドインがテナント管理者によって展開されている場合にのみ、Graph スコープへの同意をサポートします。このオプションを true に設定すると、Graph アクセスが失敗した場合に Office が事前にアドインに通知します (説明エラーを返します)。

forMSGraphAccess?: boolean;

プロパティ値

boolean

注釈

注: シングル サインオン (SSO) を使用する Outlook アドインを開発している場合は、テストのためにアドインをサイドロードする前に、 forMSGraphAccess オプションをコメント アウトしてください。 それ以外の場合は、 エラー 13012 が表示されます。 追加のガイダンスについては、「 Outlook アドインを使用した SSO の詳細」を参照してください。