OfficeRuntime.AuthOptions interface

Paket:

office-runtime

Stellt Optionen für die Benutzeroberfläche bereit, wenn Office ein Zugriffstoken für das Add-In von AAD v. 2.0 mit der getAccessToken -Methode abruft.

Hinweise

Die Methoden in dieser Schnittstelle entsprechen denen in der Office.AuthOptions -Schnittstelle. Wenn in Zukunft neue Authentifizierungstypen hinzugefügt werden, werden sie nur der Office.AuthOptions Schnittstelle hinzugefügt. Der Einfachheit halber verwenden Office.AuthOptionsdie Codebeispiele in der gesamten Dokumentation .

Eigenschaften

allowConsentPrompt	Ermöglicht Office, ein Zugriffstoken im Hintergrund oder durch interaktive Zustimmung abzurufen, falls erforderlich. Der Standardwert ist false. Wenn auf falsefestgelegt ist, versucht Office automatisch, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf truefestgelegt ist, zeigt Office eine interaktive Zustimmungsbenutzeroberfläche an, nachdem ein Zugriffstoken nicht automatisch abgerufen werden kann. Die Eingabeaufforderung lässt nur die Zustimmung für den AAD-Profilbereich zu, nicht für Microsoft Graph-Bereiche.
allowSignInPrompt	Ermöglicht Es Office, ein Zugriffstoken zu erhalten, das automatisch bereitgestellte Zustimmung vorhanden ist, oder zeigt eine interaktive Benutzeroberfläche an, um den Benutzer anzumelden. Der Standardwert ist false. Wenn auf falsefestgelegt ist, versucht Office automatisch, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf truefestgelegt ist, zeigt Office eine interaktive Anmeldebenutzeroberfläche an, nachdem ein Zugriffstoken nicht automatisch abgerufen werden kann.
asyncContext	Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext -Eigenschaft des Objekts zurückgegeben wird, das AsyncResult an einen Rückruf übergeben wird.
authChallenge	Bewirkt, dass Office den Benutzer auffordert, den zusätzlichen Faktor anzugeben, wenn der Mandanten, auf den Microsoft Graph abzielt, eine mehrstufige Authentifizierung erfordert. Der Zeichenfolgenwert gibt den Typ des zusätzlichen Faktors an, der erforderlich ist. In den meisten Fällen wissen Sie zur Entwicklungszeit nicht, ob der Mandant des Benutzers einen zusätzlichen Faktor erfordert oder wie die Zeichenfolge aussehen soll. Diese Option würde also in einem "zweiten Versuch"-Aufruf von getAccessToken verwendet, nachdem Microsoft Graph einen Fehler gesendet hat, der den zusätzlichen Faktor anfordert und die Zeichenfolge enthält, die mit der authChallenge Option verwendet werden soll.
forceAddAccount	Fordert den Benutzer auf, sein Office-Konto hinzuzufügen (oder zu wechseln, wenn es bereits hinzugefügt wurde). Der Standardwert ist false.
forceConsent	Bewirkt, dass Office die Add-In-Zustimmung anzeigt. Diese Methode ist nützlich, wenn die Add-In-Azure-Berechtigungen geändert wurden oder die Zustimmung des Benutzers gesperrt wurde. Der Standardwert ist false.
forMSGraphAccess	Bewirkt, dass Office einen beschreibenden Fehler zurückgibt, wenn das Add-In auf Microsoft Graph zugreifen möchte und der Benutzer/Administrator keine Zustimmung zu Graph-Bereichen erteilt hat. Der Standardwert ist false. Office unterstützt nur die Zustimmung zu Graph-Bereichen, wenn das Add-In von einem Mandantenadministrator bereitgestellt wurde. Wenn Sie diese Option auf festlegen true , informiert Office Ihr Add-In im Voraus (indem ein beschreibender Fehler zurückgegeben wird), wenn der Graph-Zugriff fehlschlägt.

Details zur Eigenschaft

allowConsentPrompt

Ermöglicht Office, ein Zugriffstoken im Hintergrund oder durch interaktive Zustimmung abzurufen, falls erforderlich. Der Standardwert ist false. Wenn auf falsefestgelegt ist, versucht Office automatisch, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf truefestgelegt ist, zeigt Office eine interaktive Zustimmungsbenutzeroberfläche an, nachdem ein Zugriffstoken nicht automatisch abgerufen werden kann. Die Eingabeaufforderung lässt nur die Zustimmung für den AAD-Profilbereich zu, nicht für Microsoft Graph-Bereiche.

allowConsentPrompt?: boolean;

Eigenschaftswert

boolean

allowSignInPrompt

Ermöglicht Es Office, ein Zugriffstoken zu erhalten, das automatisch bereitgestellte Zustimmung vorhanden ist, oder zeigt eine interaktive Benutzeroberfläche an, um den Benutzer anzumelden. Der Standardwert ist false. Wenn auf falsefestgelegt ist, versucht Office automatisch, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf truefestgelegt ist, zeigt Office eine interaktive Anmeldebenutzeroberfläche an, nachdem ein Zugriffstoken nicht automatisch abgerufen werden kann.

allowSignInPrompt?: boolean;

Eigenschaftswert

boolean

asyncContext

Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext -Eigenschaft des Objekts zurückgegeben wird, das AsyncResult an einen Rückruf übergeben wird.

asyncContext?: any;

Eigenschaftswert

any

authChallenge

Bewirkt, dass Office den Benutzer auffordert, den zusätzlichen Faktor anzugeben, wenn der Mandanten, auf den Microsoft Graph abzielt, eine mehrstufige Authentifizierung erfordert. Der Zeichenfolgenwert gibt den Typ des zusätzlichen Faktors an, der erforderlich ist. In den meisten Fällen wissen Sie zur Entwicklungszeit nicht, ob der Mandant des Benutzers einen zusätzlichen Faktor erfordert oder wie die Zeichenfolge aussehen soll. Diese Option würde also in einem "zweiten Versuch"-Aufruf von getAccessToken verwendet, nachdem Microsoft Graph einen Fehler gesendet hat, der den zusätzlichen Faktor anfordert und die Zeichenfolge enthält, die mit der authChallenge Option verwendet werden soll.

authChallenge?: string;

Eigenschaftswert

string

forceAddAccount

Warnung

Diese API ist nun veraltet.

Use allowSignInPrompt instead.

Fordert den Benutzer auf, sein Office-Konto hinzuzufügen (oder zu wechseln, wenn es bereits hinzugefügt wurde). Der Standardwert ist false.

forceAddAccount?: boolean;

Eigenschaftswert

boolean

forceConsent

Warnung

Diese API ist nun veraltet.

Use allowConsentPrompt instead.

Bewirkt, dass Office die Add-In-Zustimmung anzeigt. Diese Methode ist nützlich, wenn die Add-In-Azure-Berechtigungen geändert wurden oder die Zustimmung des Benutzers gesperrt wurde. Der Standardwert ist false.

forceConsent?: boolean;

Eigenschaftswert

boolean

forMSGraphAccess

Bewirkt, dass Office einen beschreibenden Fehler zurückgibt, wenn das Add-In auf Microsoft Graph zugreifen möchte und der Benutzer/Administrator keine Zustimmung zu Graph-Bereichen erteilt hat. Der Standardwert ist false. Office unterstützt nur die Zustimmung zu Graph-Bereichen, wenn das Add-In von einem Mandantenadministrator bereitgestellt wurde. Wenn Sie diese Option auf festlegen true , informiert Office Ihr Add-In im Voraus (indem ein beschreibender Fehler zurückgegeben wird), wenn der Graph-Zugriff fehlschlägt.

forMSGraphAccess?: boolean;

Eigenschaftswert

boolean

Hinweise

Hinweis: Wenn Sie ein Outlook-Add-In entwickeln, das einmaliges Anmelden (Single Sign-On, SSO) verwendet, kommentieren Sie die forMSGraphAccess Option aus, bevor Sie das Add-In zu Testzwecken querladen. Andernfalls erhalten Sie den Fehler 13012. Weitere Anleitungen finden Sie unter Details zum einmaligen Anmelden mit einem Outlook-Add-In.