Office.AuthOptions interface

Stellt Optionen für die Benutzeroberfläche zur Verfügung, wenn Office ein Zugriffstoken für das Add-In von AAD v erhält. 2.0 abruft (mit der Methode getAccessToken).

Eigenschaften

allowConsentPrompt

Ermöglicht Es Office, ein Zugriffstoken im Hintergrund oder durch interaktive Zustimmung abzurufen, falls erforderlich. Standardwert ist false. Wenn auf festgelegt falseversucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf festgelegt truezeigt Office eine interaktive Zustimmungsbenutzeroberfläche an, nachdem es nicht automatisch ein Zugriffstoken erhalten hat. Die Eingabeaufforderung lässt nur die Zustimmung zum AAD-Profilbereich zu, nicht für Microsoft Graph-Bereiche.

allowSignInPrompt

Ermöglicht Office, ein Zugriffstoken im Hintergrund abzurufen, sofern die Zustimmung vorhanden ist, oder interaktive Benutzeroberfläche zum Anmelden des Benutzers anzeigen. Standardwert ist false. Wenn auf festgelegt falseversucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf festgelegt truezeigt Office eine interaktive Anmeldebenutzeroberfläche an, nachdem es nicht automatisch ein Zugriffstoken erhalten hat.

asyncContext

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

authChallenge

Bewirkt, dass Office den Benutzer zur Bereitstellung des zusätzlichen Faktors anfordert, wenn für den von Microsoft Graph bestimmten Mandanz eine mehrstufige Authentifizierung erforderlich ist. 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 benötigt oder wie die Zeichenfolge sein soll. Diese Option wird also in einem zweiten Versuch von verwendet, nachdem Microsoft Graph einen Fehler gesendet hat, der den zusätzlichen Faktor anfordert und die Zeichenfolge enthält, die mit der Option getAccessToken verwendet werden authChallenge soll.

forceAddAccount

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

Warnung: forceAddAccount ist veraltet. Verwenden allowSignInPrompt Sie stattdessen.

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. Standardwert ist false.

Warnung: forceConsent ist veraltet. Verwenden allowConsentPrompt Sie stattdessen.

forMSGraphAccess

Bewirkt, dass Office einen beschreibenden Fehler zurück gibt, wenn das Add-In auf Microsoft Graph zugreifen möchte und der Benutzer/Administrator keine Zustimmung zu Graph-Bereich erteilt hat. Standardwert ist false. Office unterstützt nur die Zustimmung zu Graph-Bereich, wenn das Add-In von einem Mandantenadministrator bereitgestellt wurde. Diese Informationen stehen während der Entwicklung nicht zur Verfügung. Wenn Sie diese Option auf festlegen, informiert Office Ihr Add-In vorab (durch Zurückgeben eines beschreibenden Fehlers), wenn true der Graph-Zugriff fehlschlägt.

Details zur Eigenschaft

allowConsentPrompt

Ermöglicht Es Office, ein Zugriffstoken im Hintergrund oder durch interaktive Zustimmung abzurufen, falls erforderlich. Standardwert ist false. Wenn auf festgelegt falseversucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf festgelegt truezeigt Office eine interaktive Zustimmungsbenutzeroberfläche an, nachdem es nicht automatisch ein Zugriffstoken erhalten hat. Die Eingabeaufforderung lässt nur die Zustimmung zum AAD-Profilbereich zu, nicht für Microsoft Graph-Bereiche.

allowConsentPrompt?: boolean;

Eigenschaftswert

boolean

allowSignInPrompt

Ermöglicht Office, ein Zugriffstoken im Hintergrund abzurufen, sofern die Zustimmung vorhanden ist, oder interaktive Benutzeroberfläche zum Anmelden des Benutzers anzeigen. Standardwert ist false. Wenn auf festgelegt falseversucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fehler ist, gibt Office einen beschreibenden Fehler zurück. Wenn auf festgelegt truezeigt Office eine interaktive Anmeldebenutzeroberfläche an, nachdem es nicht automatisch ein Zugriffstoken erhalten hat.

allowSignInPrompt?: boolean;

Eigenschaftswert

boolean

asyncContext

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

asyncContext?: any;

Eigenschaftswert

any

authChallenge

Bewirkt, dass Office den Benutzer zur Bereitstellung des zusätzlichen Faktors anfordert, wenn für den von Microsoft Graph bestimmten Mandanz eine mehrstufige Authentifizierung erforderlich ist. 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 benötigt oder wie die Zeichenfolge sein soll. Diese Option wird also in einem zweiten Versuch von verwendet, nachdem Microsoft Graph einen Fehler gesendet hat, der den zusätzlichen Faktor anfordert und die Zeichenfolge enthält, die mit der Option getAccessToken verwendet werden authChallenge soll.

authChallenge?: string;

Eigenschaftswert

string

forceAddAccount

Warnung

Diese API ist jetzt veraltet.

Use allowSignInPrompt instead.

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

Warnung: forceAddAccount ist veraltet. Verwenden allowSignInPrompt Sie stattdessen.

forceAddAccount?: boolean;

Eigenschaftswert

boolean

forceConsent

Warnung

Diese API ist jetzt 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. Standardwert ist false.

Warnung: forceConsent ist veraltet. Verwenden allowConsentPrompt Sie stattdessen.

forceConsent?: boolean;

Eigenschaftswert

boolean

forMSGraphAccess

Bewirkt, dass Office einen beschreibenden Fehler zurück gibt, wenn das Add-In auf Microsoft Graph zugreifen möchte und der Benutzer/Administrator keine Zustimmung zu Graph-Bereich erteilt hat. Standardwert ist false. Office unterstützt nur die Zustimmung zu Graph-Bereich, wenn das Add-In von einem Mandantenadministrator bereitgestellt wurde. Diese Informationen stehen während der Entwicklung nicht zur Verfügung. Wenn Sie diese Option auf festlegen, informiert Office Ihr Add-In vorab (durch Zurückgeben eines beschreibenden Fehlers), wenn true der Graph-Zugriff fehlschlägt.

forMSGraphAccess?: boolean;

Eigenschaftswert

boolean