Office.AuthOptions interface

パッケージ:

office

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

プロパティ

allowConsentPrompt	Office がアクセス トークンをサイレントモードで取得するか、対話型の同意を通じて取得できるようにします (必要な場合)。 既定値は falseです。 false に設定すると、Office はアクセス トークンの取得をサイレント モードで試みます。 失敗した場合、Office は説明的なエラーを返します。 true に設定すると、アクセス トークンのサイレント 取得に失敗した後、Office に対話型の同意 UI が表示されます。 プロンプトでは、AAD プロファイル スコープへの同意のみが許可され、Microsoft Graph スコープへの同意は許可されません。
allowSignInPrompt	同意が存在する場合、または対話型 UI を表示してユーザーにサインインすると、Office がアクセス トークンをサイレント モードで取得できるようにします。 既定値は falseです。 false に設定すると、Office はアクセス トークンの取得をサイレント モードで試みます。 失敗した場合、Office は説明的なエラーを返します。 true に設定すると、アクセス トークンをサイレントモードで取得できないと、対話型サインイン UI が表示されます。
asyncContext	コールバックに渡されるAsyncResult オブジェクトの asyncContext プロパティで返される、変更されていない任意の型のユーザー定義項目。
authChallenge	Microsoft Graph の対象となるテナントに多要素認証が必要な場合に、追加の要素を指定するようにユーザーに求めるメッセージが Office に表示されます。 文字列値は、必要な追加要素の種類を識別します。 ほとんどの場合、開発時に、ユーザーのテナントに追加の要素が必要かどうか、または文字列の内容がわかりません。 そのため、このオプションは、Microsoft Graph が追加の要素を要求し、authChallenge オプションで使用する文字列を含むエラーを送信した後、getAccessTokenの "2 回目の試行" 呼び出しで使用されます。
forceAddAccount	Office アカウントを追加するようにユーザーに求めます (または、既に追加されている場合はそれに切り替えます)。 既定値は falseです。 警告: forceAddAccount は非推奨になりました。 代わりに allowSignInPrompt を使用します。
forceConsent	Office によりアドインの同意エクスペリエンスが表示されます。 アドインの Azure アクセス許可が変更された場合や、ユーザーの同意が取り消された場合に役立ちます。 既定値は falseです。 警告: forceConsent は非推奨になりました。 代わりに allowConsentPrompt を使用します。
forMSGraphAccess	アドインが Microsoft Graph にアクセスする必要があり、ユーザー/管理者が Graph スコープに同意していない場合に、Office からわかりやすいエラーが返されます。 既定値は falseです。 Office では、テナント管理者によってアドインが展開されている場合にのみ、Graph スコープへの同意がサポートされます。このオプションを true に設定すると、Graph アクセスが失敗した場合にアドインに事前に通知されます (わかりやすいエラーが返されます)。

プロパティの詳細

allowConsentPrompt

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

allowConsentPrompt?: boolean;

プロパティ値

boolean

allowSignInPrompt

同意が存在する場合、または対話型 UI を表示してユーザーにサインインすると、Office がアクセス トークンをサイレント モードで取得できるようにします。 既定値は falseです。 false に設定すると、Office はアクセス トークンの取得をサイレント モードで試みます。 失敗した場合、Office は説明的なエラーを返します。 true に設定すると、アクセス トークンをサイレントモードで取得できないと、対話型サインイン UI が表示されます。

allowSignInPrompt?: boolean;

プロパティ値

boolean

asyncContext

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

asyncContext?: any;

プロパティ値

any

authChallenge

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

authChallenge?: string;

プロパティ値

string

forceAddAccount

警告

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

Use allowSignInPrompt instead.

Office アカウントを追加するようにユーザーに求めます (または、既に追加されている場合はそれに切り替えます)。 既定値は falseです。

警告: forceAddAccount は非推奨になりました。 代わりに allowSignInPrompt を使用します。

forceAddAccount?: boolean;

プロパティ値

boolean

forceConsent

警告

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

Use allowConsentPrompt instead.

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

警告: forceConsent は非推奨になりました。 代わりに allowConsentPrompt を使用します。

forceConsent?: boolean;

プロパティ値

boolean

forMSGraphAccess

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

forMSGraphAccess?: boolean;

プロパティ値

boolean

注釈

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