OfficeRuntime.AuthOptions interface

Paket:
office-runtime

Warnung

Diese API ist nun veraltet.

Use the Office.AuthOptions interface instead.

Stellt Optionen für die Benutzererfahrung bereit, wenn Office ein Zugriffstoken für das Add-In von AAD Version 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 .

Verwendet von

Beispiele

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

Eigenschaften

allowConsentPrompt

Ermöglicht Office, ein Zugriffstoken im Hintergrund oder durch interaktive Zustimmung abzurufen, falls eines erforderlich ist. Der Standardwert ist false. Wenn diese Option festgelegt ist false, versucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fall ist, gibt Office einen beschreibenden Fehler zurück. Wenn diese Option festgelegt ist true, zeigt Office eine interaktive Zustimmungsbenutzeroberfläche an, nachdem kein Zugriffstoken im Hintergrund abgerufen wurde. Die Eingabeaufforderung erlaubt nur die Zustimmung zum AAD-Profilbereich, nicht zu Microsoft Graph-Bereichen.
allowSignInPrompt

Ermöglicht Office, ein Zugriffstoken abzurufen, wenn die Zustimmung im Hintergrund vorliegt, oder die interaktive Benutzeroberfläche anzuzeigen, um den Benutzer anzumelden. Der Standardwert ist false. Wenn diese Option festgelegt ist false, versucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fall ist, gibt Office einen beschreibenden Fehler zurück. Wenn diese Option festgelegt ist true, zeigt Office eine interaktive Anmeldebenutzeroberfläche an, nachdem kein Zugriffstoken im Hintergrund abgerufen wurde.
asyncContext

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

Veranlasst Office, den Benutzer aufzufordern, den zusätzlichen Faktor anzugeben, wenn für den Mandanten, der von Microsoft Graph angestrebt wird, eine mehrstufige Authentifizierung erforderlich ist. Der Zeichenfolgenwert identifiziert den Typ des erforderlichen zusätzlichen Faktors. 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. Daher würde diese Option in einem "zweiten Versuch"-Aufruf verwendet werden, nachdem getAccessToken Microsoft Graph einen Fehler gesendet hat, in dem der zusätzliche Faktor angefordert wird und die Zeichenfolge enthält, die mit der authChallenge Option verwendet werden soll.
forceAddAccount

Prompts den Benutzer, sein Office-Konto hinzuzufügen (oder zu ihm 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 die Zustimmung zu Graph-Bereichen nur, wenn das Add-In von einem Mandantenadministrator bereitgestellt wurde. Wenn Sie diese Option festlegen true , informiert Office Ihr Add-In vorab (durch Rückgabe eines beschreibenden Fehlers), falls der Graph-Zugriff fehlschlägt.

Details zur Eigenschaft

allowConsentPrompt

Ermöglicht Office, ein Zugriffstoken im Hintergrund oder durch interaktive Zustimmung abzurufen, falls eines erforderlich ist. Der Standardwert ist false. Wenn diese Option festgelegt ist false, versucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fall ist, gibt Office einen beschreibenden Fehler zurück. Wenn diese Option festgelegt ist true, zeigt Office eine interaktive Zustimmungsbenutzeroberfläche an, nachdem kein Zugriffstoken im Hintergrund abgerufen wurde. Die Eingabeaufforderung erlaubt nur die Zustimmung zum AAD-Profilbereich, nicht zu Microsoft Graph-Bereichen.

allowConsentPrompt?: boolean;

Eigenschaftswert

boolean

allowSignInPrompt

Ermöglicht Office, ein Zugriffstoken abzurufen, wenn die Zustimmung im Hintergrund vorliegt, oder die interaktive Benutzeroberfläche anzuzeigen, um den Benutzer anzumelden. Der Standardwert ist false. Wenn diese Option festgelegt ist false, versucht Office im Hintergrund, ein Zugriffstoken abzurufen. Wenn dies nicht der Fall ist, gibt Office einen beschreibenden Fehler zurück. Wenn diese Option festgelegt ist true, zeigt Office eine interaktive Anmeldebenutzeroberfläche an, nachdem kein Zugriffstoken im Hintergrund abgerufen wurde.

allowSignInPrompt?: boolean;

Eigenschaftswert

boolean

asyncContext

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

asyncContext?: any;

Eigenschaftswert

any

authChallenge

Veranlasst Office, den Benutzer aufzufordern, den zusätzlichen Faktor anzugeben, wenn für den Mandanten, der von Microsoft Graph angestrebt wird, eine mehrstufige Authentifizierung erforderlich ist. Der Zeichenfolgenwert identifiziert den Typ des erforderlichen zusätzlichen Faktors. 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. Daher würde diese Option in einem "zweiten Versuch"-Aufruf verwendet werden, nachdem getAccessToken Microsoft Graph einen Fehler gesendet hat, in dem der zusätzliche Faktor angefordert wird 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.

Prompts den Benutzer, sein Office-Konto hinzuzufügen (oder zu ihm 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 die Zustimmung zu Graph-Bereichen nur, wenn das Add-In von einem Mandantenadministrator bereitgestellt wurde. Wenn Sie diese Option festlegen true , informiert Office Ihr Add-In vorab (durch Rückgabe eines beschreibenden Fehlers), falls der Graph-Zugriff fehlschlägt.

forMSGraphAccess?: boolean;

Eigenschaftswert

boolean

Hinweise

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